SFTPClient.Adapter.SFTP behaviour (SFTP Client v1.4.3) View Source

A behavior that defines required callbacks for a low-level SFTP adapter.

Link to this section Summary

Callbacks

close(channel_pid, handle, timeout)

del_dir(channel_pid, path, timeout)

delete(channel_pid, path, timeout)

list_dir(channel_pid, path, timeout)

make_dir(channel_pid, path, timeout)

make_link(channel_pid, symlink_path, target_path, timeout)

open(channel_pid, path, modes, timeout)

opendir(channel_pid, path, timeout)

read(channel_pid, handle, length, timeout)

read_file(channel_pid, path, timeout)

read_file_info(channel_pid, path, timeout)

read_link(channel_pid, path, timeout)

read_link_info(channel_pid, path, timeout)

readdir(channel_pid, handle, timeout)

rename(channel_pid, old_path, new_path, timeout)

start_channel(host, port, opts)

stop_channel(channel_pid)

write(channel_pid, path, data, timeout)

write_file(channel_pid, path, data, timeout)

Link to this section Callbacks

close(channel_pid, handle, timeout)

Specs

close(channel_pid :: pid(), handle :: term(), timeout()) ::
  :ok | {:error, any()}

del_dir(channel_pid, path, timeout)

Specs

del_dir(channel_pid :: pid(), path :: charlist(), timeout()) ::
  :ok | {:error, any()}

delete(channel_pid, path, timeout)

Specs

delete(channel_pid :: pid(), path :: charlist(), timeout()) ::
  :ok | {:error, any()}

list_dir(channel_pid, path, timeout)

Specs

list_dir(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, [charlist()]} | {:error, any()}

list_dir(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, [charlist()]} | {:error, any()}

make_dir(channel_pid, path, timeout)

Specs

make_dir(channel_pid :: pid(), path :: charlist(), timeout()) ::
  :ok | {:error, any()}

make_link(channel_pid, symlink_path, target_path, timeout)

Specs

make_link(
  channel_pid :: pid(),
  symlink_path :: charlist(),
  target_path :: charlist(),
  timeout()
) :: :ok | {:error, any()}

open(channel_pid, path, modes, timeout)

Specs

open(
  channel_pid :: pid(),
  path :: charlist(),
  modes :: [SFTPClient.access_mode()],
  timeout()
) :: {:ok, term()} | {:error, any()}

opendir(channel_pid, path, timeout)

Specs

opendir(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, term()} | {:error, any()}

read(channel_pid, handle, length, timeout)

Specs

read(
  channel_pid :: pid(),
  handle :: term(),
  length :: non_neg_integer(),
  timeout()
) :: {:ok, binary()} | :eof | {:error, any()}

read_file(channel_pid, path, timeout)

Specs

read_file(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, binary()} | {:error, any()}

read_file_info(channel_pid, path, timeout)

Specs

read_file_info(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, term()} | {:error, any()}

read_link(channel_pid, path, timeout)

Specs

read_link(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, charlist()} | {:error, any()}

read_link_info(channel_pid, path, timeout)

Specs

read_link_info(channel_pid :: pid(), path :: charlist(), timeout()) ::
  {:ok, term()} | {:error, any()}

readdir(channel_pid, handle, timeout)

Specs

readdir(channel_pid :: pid(), handle :: term(), timeout()) ::
  {:ok, binary()} | {:error, any()}

rename(channel_pid, old_path, new_path, timeout)

Specs

rename(
  channel_pid :: pid(),
  old_path :: charlist(),
  new_path :: charlist(),
  timeout()
) :: :ok | {:error, any()}

start_channel(host, port, opts)

Specs

start_channel(
  host :: charlist(),
  port :: non_neg_integer(),
  opts :: Keyword.t()
) :: {:ok, pid(), pid()} | {:error, any()}

stop_channel(channel_pid)

Specs

stop_channel(channel_pid :: pid()) :: :ok

write(channel_pid, path, data, timeout)

Specs

write(channel_pid :: pid(), path :: charlist(), data :: binary(), timeout()) ::
  :ok | {:error, any()}

write_file(channel_pid, path, data, timeout)

Specs

write_file(
  channel_pid :: pid(),
  path :: charlist(),
  data :: [binary()],
  timeout()
) :: :ok | {:error, any()}