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

A module that provides functions to read a list of directories on an SFTP server from a given file handle.

Link to this section Summary

Functions

Reads the directory contents 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_dir(SFTPClient.Handle.t()) ::
  {:ok, [any()]} | :eof | {:error, SFTPClient.error()}

Reads the directory contents from the server, and returns the data as String.

Specs

read_dir!(SFTPClient.Handle.t()) :: [any()] | :eof | no_return()

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