SFTP Client v1.1.1 SFTPClient.Operations.OpenDir View Source
A module that provides functions to open a directory on an SFTP server in order to list their contents.
Link to this section Summary
Functions
Opens a handle to a directory on the server. The handle can be used for reading directory contents.
Opens a handle to a directory on the server. The handle can be used for reading directory contents. Raises when the operation fails.
Link to this section Functions
Link to this function
open_dir(conn, path)
View Source
open_dir(conn, path)
View Source
open_dir(SFTPClient.Conn.t(), String.t()) ::
{:ok, SFTPClient.Handle.t()} | {:error, any()}
open_dir(SFTPClient.Conn.t(), String.t()) :: {:ok, SFTPClient.Handle.t()} | {:error, any()}
Opens a handle to a directory on the server. The handle can be used for reading directory contents.
Link to this function
open_dir!(conn, path)
View Source
open_dir!(conn, path)
View Source
open_dir!(SFTPClient.Conn.t(), String.t()) ::
SFTPClient.Handle.t() | no_return()
open_dir!(SFTPClient.Conn.t(), String.t()) :: SFTPClient.Handle.t() | no_return()
Opens a handle to a directory on the server. The handle can be used for reading directory contents. Raises when the operation fails.