Depot.Filesystem behaviour (Depot v0.5.2) View Source

Behaviour of a Depot filesystem.

Link to this section Summary

Callbacks

copy(source, destination, opts)

delete(path, opts)

file_exists(path, opts)

list_contents(path, opts)

move(source, destination, opts)

read(path, opts)

read_stream(path, opts)

write(path, contents, opts)

Functions

merge_app_env(opts, module)

parse_opts(module, opts)

Link to this section Callbacks

copy(source, destination, opts)

Specs

copy(source :: Path.t(), destination :: Path.t(), opts :: keyword()) ::
  :ok | {:error, term()}

delete(path, opts)

Specs

delete(path :: Path.t(), opts :: keyword()) :: :ok | {:error, term()}

file_exists(path, opts)

Specs

file_exists(path :: Path.t(), opts :: keyword()) ::
  {:ok, :exists | :missing} | {:error, term()}

list_contents(path, opts)

Specs

list_contents(path :: Path.t(), opts :: keyword()) ::
  {:ok,
   [
     %Depot.Stat.Dir{
       mtime: term(),
       name: term(),
       size: term(),
       visibility: term()
     }
     | %Depot.Stat.File{
         mtime: term(),
         name: term(),
         size: term(),
         visibility: term()
       }
   ]}
  | {:error, term()}

move(source, destination, opts)

Specs

move(source :: Path.t(), destination :: Path.t(), opts :: keyword()) ::
  :ok | {:error, term()}

read(path, opts)

Specs

read(path :: Path.t(), opts :: keyword()) :: {:ok, binary()} | {:error, term()}

read_stream(path, opts)

Specs

read_stream(path :: Path.t(), opts :: keyword()) ::
  {:ok, Enumerable.t()} | {:error, term()}

write(path, contents, opts)

Specs

write(path :: Path.t(), contents :: binary(), opts :: keyword()) ::
  :ok | {:error, term()}

Link to this section Functions

merge_app_env(opts, module)