SFTP Client v1.3.3 SFTPClient.Operations.DownloadFile View Source
A module that provides functions to download files from an SFTP server.
Link to this section Summary
Functions
Downloads a file from the remote path and stores it in the given local path. When the local path is a directory, the file name of the local file is inferred from the remote path.
Downloads a file from the remote path and stores it in the given local path. When the local path is a directory, the file name of the local file is inferred from the remote path. Raises when the operation fails.
Link to this section Functions
download_file(conn, remote_path, local_path)
View Source
download_file(SFTPClient.Conn.t(), Path.t(), Path.t()) ::
{:ok, Path.t()} | {:error, SFTPClient.error()}
download_file(SFTPClient.Conn.t(), Path.t(), Path.t()) :: {:ok, Path.t()} | {:error, SFTPClient.error()}
Downloads a file from the remote path and stores it in the given local path. When the local path is a directory, the file name of the local file is inferred from the remote path.
download_file!(conn, remote_path, local_path)
View Source
download_file!(SFTPClient.Conn.t(), Path.t(), Path.t()) ::
Path.t() | no_return()
download_file!(SFTPClient.Conn.t(), Path.t(), Path.t()) :: Path.t() | no_return()
Downloads a file from the remote path and stores it in the given local path. When the local path is a directory, the file name of the local file is inferred from the remote path. Raises when the operation fails.