SFTPClient.Config (SFTP Client v1.4.3) View Source

A module containing the connection configuration.

Link to this section Summary

Types

t()

Functions

new(config_or_opts)

Builds a config from the given SFTPClient.Config struct, keyword list or map.

Link to this section Types

t()

Specs

t() :: %SFTPClient.Config{
  connect_timeout: timeout(),
  dsa_pass_phrase: nil | String.t(),
  ecdsa_pass_phrase: nil | String.t(),
  host: String.t(),
  inet: :inet | :inet6,
  key_cb: {module(), term()},
  operation_timeout: timeout(),
  password: nil | String.t(),
  port: non_neg_integer(),
  private_key_pass_phrase: nil | String.t(),
  private_key_path: nil | Path.t(),
  rsa_pass_phrase: nil | String.t(),
  sftp_vsn: integer(),
  system_dir: nil | Path.t(),
  user: String.t(),
  user_dir: nil | Path.t()
}

Link to this section Functions

new(config_or_opts)

Specs

new(t() | Keyword.t() | %{optional(atom()) => any()}) :: t()

Builds a config from the given SFTPClient.Config struct, keyword list or map.