SFTP Client

SFTP Client v1.4.0 SFTPClient.OperationUtil View Source

A utility module that intends to be imported by operation modules.

Link to this section Summary

Functions

handle_error(error)

A function which converts all errors that can occur when an SFTP operation fails into a matching exception struct.

may_bang!(result)

Converts the result of a non-bang function so that the result is returned or an exception is raised on error.

sftp_adapter()

Gets the configured SFTP adapter. Defaults to the Erlang :ssh_sftp module.

ssh_adapter()

Gets the configured SSH adapter. Defaults to the Erlang :ssh module.

Link to this section Functions

Link to this function

handle_error(error) View Source 
handle_error(any()) ::
  SFTPClient.ConnError.t()
  | SFTPClient.InvalidOptionError.t()
  | SFTPClient.OperationError.t()

A function which converts all errors that can occur when an SFTP operation fails into a matching exception struct.

Link to this function

may_bang!(result) View Source 
may_bang!(:ok | {:ok | :error, any()}) :: any() | no_return()

Converts the result of a non-bang function so that the result is returned or an exception is raised on error.

Link to this function

sftp_adapter() View Source 
sftp_adapter() :: module()

Gets the configured SFTP adapter. Defaults to the Erlang :ssh_sftp module.

Link to this function

ssh_adapter() View Source 
ssh_adapter() :: module()

Gets the configured SSH adapter. Defaults to the Erlang :ssh module.

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog