SFTP Client

SFTP Client v1.3.2 SFTPClient.Operations.StreamFile 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)
stream_file!(conn, path)

Creates a stream that allows reading from and writing to the server. May raise lazily as soon as the Stream evaluates.

stream_file!(conn, path, chunk_size)

Link to this section Functions

Link to this function

stream_file(conn, path) View Source 
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 
stream_file(SFTPClient.Conn.t(), Path.t(), non_neg_integer()) ::
  {:ok, SFTPClient.Stream.t()} | {:error, SFTPClient.error()}

Link to this function

stream_file!(conn, path) View Source 
stream_file!(SFTPClient.Conn.t(), Path.t()) :: SFTPClient.Stream.t()

Creates a stream that allows reading from and writing to the server. May raise lazily as soon as the Stream evaluates.

Link to this function

stream_file!(conn, path, chunk_size) View Source 
stream_file!(SFTPClient.Conn.t(), Path.t(), non_neg_integer()) ::
  SFTPClient.Stream.t()

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