SFTP Client

SFTP Client v1.4.1 SFTPClient.Operations.Rename View Source

A module that provides functions to rename files and directories on an SFTP server.

Link to this section Summary

Functions

rename(conn, old_path, new_path)

Renames a file named old_path and gives it the name specified by new_path.

rename!(conn, old_path, new_path)

Renames a file named old_path and gives it the name specified by new_path. Raises when the operation fails.

Link to this section Functions

Link to this function

rename(conn, old_path, new_path)

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

Renames a file named old_path and gives it the name specified by new_path.

Link to this function

rename!(conn, old_path, new_path)

View Source 
rename!(SFTPClient.Conn.t(), Path.t(), Path.t()) :: :ok | no_return()

Renames a file named old_path and gives it the name specified by new_path. Raises when the operation fails.