Capsule v1.0.0 Capsule.Storage behaviour View Source

Defines the behaviour for storage backends.

Implement this behaviour to create a storage adapter that can read, write, stream, and delete files.

Link to this section Summary

error()

option()

error() :: {:error, String.t()}

locator_id() :: String.t()

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

delete(locator_id()) :: :ok | error()

delete(locator_id(), [option()]) :: :ok | error()

put(Capsule.Upload.t()) :: {:ok, locator_id()} | error()

put(Capsule.Upload.t(), [option()]) :: {:ok, locator_id()} | error()

read(locator_id()) :: {:ok, binary()} | error()

read(locator_id(), [option()]) :: {:ok, binary()} | error()

stream!(locator_id()) :: Enumerable.t()

stream!(locator_id(), [option()]) :: Enumerable.t()