Ash.Type.File.Implementation behaviour (ash v3.19.3)

Behaviour for file implementations that are compatible with Ash.Type.File.

Summary

error()

Errors returned by the implementation.

source()

The source of the file the implementation operates on.

t()

Any module() implementing the Ash.Type.File.Implementation behaviour.

Return the MIME content type of the file.

filename(file)

Return the filename of the file.

Open IO.device() for the file.

path(file)

Return path of the file on disk.

@type error() :: term()

Errors returned by the implementation.

@type source() :: term()

The source of the file the implementation operates on.

@type t() :: module()

Any module() implementing the Ash.Type.File.Implementation behaviour.

(optional)

@callback content_type(file :: source()) :: {:ok, String.t()} | {:error, error()}

Return the MIME content type of the file.

This callback is optional. If the implementation cannot determine the content type, this callback can be omitted.

(optional)

@callback filename(file :: source()) :: {:ok, String.t()} | {:error, error()}

Return the filename of the file.

This callback is optional. If the implementation cannot determine the filename, this callback can be omitted.

@callback open(file :: source(), modes :: [File.mode()]) ::
  {:ok, IO.device()} | {:error, error()}

Open IO.device() for the file.

The return pid must point to a process following the Erlang I/O Protocol like StringIO or File.

(optional)

@callback path(file :: source()) :: {:ok, Path.t()} | {:error, error()}

Return path of the file on disk.

This callback is optional. If the file is not stored on disk, this callback can be omitted.