View Source SFTPClient.Operations.ListDir (SFTP Client v2.1.0)

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

Summary

Functions

list_dir(conn, path)

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

list_dir!(conn, path)

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

Functions

Link to this function

list_dir(conn, path)

View Source 
@spec 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.

Link to this function

list_dir!(conn, path)

View Source 
@spec 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.