View Source SFTPClient.Operations.ReadLink (SFTP Client v2.0.1)

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

Summary

Functions

read_link(conn, path)

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

read_link!(conn, path)

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

Functions

Link to this function

read_link(conn, path)

View Source 
@spec read_link(SFTPClient.Conn.t(), Path.t()) ::
  {:ok, Path.t()} | {:error, SFTPClient.error()}

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

Link to this function

read_link!(conn, path)

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