Capsule v1.0.0 Capsule.Uploader behaviour View Source

Defines the behaviour for uploaders and provides a use macro for generating default implementations.

Link to this section Summary

Types

option()

storage()

Functions

__using__(opts)

Generates default implementations of store/3, build_options/3, and build_metadata/3.

Callbacks

build_metadata(arg1, storage, list)

build_options(any, storage, list)

store(any, storage, list)

Link to this section Types

option()

Specs

option() :: {atom(), any()}

storage()

Specs

storage() :: atom()

Link to this section Functions

using(opts)

(macro)

Generates default implementations of store/3, build_options/3, and build_metadata/3.

Options

:storages - required. A keyword list mapping storage keys to storage modules, or an MFA tuple {module, function, args} that returns such a list at runtime.

Link to this section Callbacks

build_metadata(arg1, storage, list)

Specs

build_metadata(Capsule.Locator.t(), storage(), [option()]) ::
  Keyword.t() | map()

build_options(any, storage, list)

Specs

build_options(any(), storage(), [option()]) :: [option()]

store(any, storage, list)

Specs

store(any(), storage(), [option()]) ::
  {:ok, Capsule.Locator.t()} | {:error, any()}