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

A module that provides functions to retrieve a list of files in the given directory from an SFTP server.

Link to this section Summary

Functions

Lists the given directory on the server, returning the filenames as a list of strings.

Lists the given directory on the server, returning the filenames as a list of strings. Raises when the operation fails.

Link to this section Functions

Specs

list_dir(SFTPClient.Conn.t(), Path.t()) ::
  {:ok, [String.t()]} | {:error, SFTPClient.error()}

Lists the given directory on the server, returning the filenames as a list of strings.

Specs

list_dir!(SFTPClient.Conn.t(), Path.t()) :: [String.t()] | no_return()

Lists the given directory on the server, returning the filenames as a list of strings. Raises when the operation fails.