Waffle.Storage behaviour (waffle v2.0.0)

Copy Markdown View Source

Defines the behavior for file storage.

Callbacks

  • put/3: Saves a file and returns the file name or an error.
  • url/3: Generates a URL for accessing a file.
  • delete/3: Deletes a file and returns the result of the operation.

Summary

Callbacks

delete(definition, version, file_and_scope)
put(definition, version, file_and_scope)
url(definition, version, file_and_scope)

Callbacks

delete(definition, version, file_and_scope)

@callback delete(
  definition :: atom(),
  version :: atom(),
  file_and_scope :: {Waffle.File.t(), any()}
) ::
  atom()

put(definition, version, file_and_scope)

@callback put(
  definition :: atom(),
  version :: atom(),
  file_and_scope :: {Waffle.File.t(), any()}
) ::
  {:ok, file_name :: String.t()} | {:error, reason :: any()}

url(definition, version, file_and_scope)

@callback url(
  definition :: atom(),
  version :: atom(),
  file_and_scope :: {Waffle.File.t(), any()}
) ::
  String.t()