Capsule v1.0.0 Capsule.Upload protocol View Source

Protocol for reading upload contents and name from any data structure.

Link to this section Summary

t()

All the types that implement this protocol.

Returns the contents of the upload as an iodata binary.

Returns the name of the upload. Falls back to the locator ID if no name is set in metadata.

t() :: term()

All the types that implement this protocol.

contents(struct()) :: {:ok, iodata()} | {:error, String.t()}

Returns the contents of the upload as an iodata binary.

name(struct()) :: String.t()

Returns the name of the upload. Falls back to the locator ID if no name is set in metadata.