SFTPClient.Operations.ReadFile (SFTP Client v1.4.6) View Source

A module that provides functions to read file contents from an SFTP server.

Link to this section Summary

Functions

Reads a file from the server, and returns the data as String.

Reads a file from the server, and returns the data as String. Raises when the operation fails.

Link to this section Functions

Specs

read_file(SFTPClient.Conn.t(), Path.t()) ::
  {:ok, binary()} | {:error, SFTPClient.error()}

Reads a file from the server, and returns the data as String.

Specs

read_file!(SFTPClient.Conn.t(), Path.t()) :: binary() | no_return()

Reads a file from the server, and returns the data as String. Raises when the operation fails.