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

Behaviour for how Depot adapters work.

Link to this section Summary

Types

config()

directory_delete_opts()

path()

stream_opts()

write_opts()

Callbacks

clear(config)

configure(keyword)

copy(config, source, destination, write_opts)

copy(source_config, source, destination_config, destination, write_opts)

create_directory(config, path, write_opts)

delete(config, path)

delete_directory(config, path, directory_delete_opts)

file_exists(config, path)

list_contents(config, path)

move(config, source, destination, write_opts)

read(config, path)

read_stream(config, path, stream_opts)

set_visibility(config, path, t)

starts_processes()

visibility(config, path)

write(config, path, contents, write_opts)

write_stream(config, path, stream_opts)

Link to this section Types

config()

Specs

config() :: struct()

directory_delete_opts()

Specs

directory_delete_opts() :: keyword()

path()

Specs

path() :: Path.t()

stream_opts()

Specs

stream_opts() :: keyword()

write_opts()

Specs

write_opts() :: keyword()

Link to this section Callbacks

clear(config)

Specs

clear(config()) :: :ok | {:error, term()}

configure(keyword)

Specs

configure(keyword()) :: {module(), config()}

copy(config, source, destination, write_opts)

Specs

copy(config(), source :: path(), destination :: path(), write_opts()) ::
  :ok | {:error, term()}

copy(source_config, source, destination_config, destination, write_opts)

Specs

copy(
  source_config :: config(),
  source :: path(),
  destination_config :: config(),
  destination :: path(),
  write_opts()
) :: :ok | {:error, term()}

create_directory(config, path, write_opts)

Specs

create_directory(config(), path(), write_opts()) :: :ok | {:error, term()}

delete(config, path)

Specs

delete(config(), path()) :: :ok | {:error, term()}

delete_directory(config, path, directory_delete_opts)

Specs

delete_directory(config(), path(), directory_delete_opts()) ::
  :ok | {:error, term()}

file_exists(config, path)

Specs

file_exists(config(), path()) :: {:ok, :exists | :missing} | {:error, term()}

list_contents(config, path)

Specs

list_contents(config(), path()) ::
  {: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(config, source, destination, write_opts)

Specs

move(config(), source :: path(), destination :: path(), write_opts()) ::
  :ok | {:error, term()}

read(config, path)

Specs

read(config(), path()) :: {:ok, binary()} | {:error, term()}

read_stream(config, path, stream_opts)

Specs

read_stream(config(), path(), stream_opts()) ::
  {:ok, Enumerable.t()} | {:error, term()}

set_visibility(config, path, t)

Specs

set_visibility(config(), path(), Depot.Visibility.t()) :: :ok | {:error, term()}

starts_processes()

Specs

starts_processes() :: boolean()

visibility(config, path)

Specs

visibility(config(), path()) :: {:ok, Depot.Visibility.t()} | {:error, term()}

write(config, path, contents, write_opts)

Specs

write(config(), path(), contents :: iodata(), write_opts()) ::
  :ok | {:error, term()}

write_stream(config, path, stream_opts)

Specs

write_stream(config(), path(), stream_opts()) ::
  {:ok, Collectable.t()} | {:error, term()}