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

A module that provides functions to retrieve the target of a symbolic link on an SFTP server.

Link to this section Summary

Functions

Reads the link target from the symbolic link specified by path.

Reads the link target from the symbolic link specified by path. Raises when the operation fails.

Link to this section Functions

Specs

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

Reads the link target from the symbolic link specified by path.

Specs

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

Reads the link target from the symbolic link specified by path. Raises when the operation fails.