SFTP Client v1.1.1 SFTPClient.Operations.OpenFile View Source

A module that provides functions to open a file on an SFTP server in order to read their contents.

Link to this section Summary

Functions

Opens a file on the server and returns a handle, which can be used for reading or writing.

Opens a file on the server and returns a handle, which can be used for reading or writing. Raises when the operation fails.

Link to this section Functions

Link to this function

open_file(conn, path, modes) View Source
open_file(SFTPClient.Conn.t(), String.t(), [SFTPClient.access_mode()]) ::
  {:ok, SFTPClient.Handle.t()} | {:error, any()}

Opens a file on the server and returns a handle, which can be used for reading or writing.

Opens a file on the server and returns a handle, which can be used for reading or writing. Raises when the operation fails.