SFTP Client

SFTPClient.Operations.StreamFile (SFTP Client v1.4.3) View Source

A module that provides functions to create streams from and to files on an SFTP server.

Link to this section Summary

Functions

stream_file(conn, path)

Creates a stream that allows reading from and writing to the server.

stream_file(conn, path, chunk_size)

Creates a stream that allows reading from and writing to the server using the specified chunk size.

stream_file!(conn, path)

Creates a stream that allows reading from and writing to the server.

stream_file!(conn, path, chunk_size)

Creates a stream that allows reading from and writing to the server using the specified chunk size.

Link to this section Functions

Link to this function

stream_file(conn, path)

View Source

Specs

stream_file(SFTPClient.Conn.t(), Path.t()) ::
  {:ok, SFTPClient.Stream.t()} | {:error, SFTPClient.error()}

Creates a stream that allows reading from and writing to the server.

Link to this function

stream_file(conn, path, chunk_size)

View Source

Specs

stream_file(SFTPClient.Conn.t(), Path.t(), non_neg_integer()) ::
  {:ok, SFTPClient.Stream.t()} | {:error, SFTPClient.error()}

Creates a stream that allows reading from and writing to the server using the specified chunk size.

Link to this function

stream_file!(conn, path)

View Source

Specs

stream_file!(SFTPClient.Conn.t(), Path.t()) :: SFTPClient.Stream.t()

Creates a stream that allows reading from and writing to the server.

Link to this function

stream_file!(conn, path, chunk_size)

View Source

Specs

stream_file!(SFTPClient.Conn.t(), Path.t(), non_neg_integer()) ::
  SFTPClient.Stream.t()

Creates a stream that allows reading from and writing to the server using the specified chunk size.