Struct openssh_sftp_client::fs::Fs

pub struct Fs { /* private fields */ }

A struct used to perform operations on remote filesystem.

Implementations

impl Fs

pub fn cwd(&self) -> &Path

Return current working dir.

pub fn set_cwd(&mut self, cwd: impl Into<PathBuf>)

Set current working dir.

• cwd - Can include ~. If it is empty, then it is set to use the default directory set by the remote sftp-server.

impl Fs

pub async fn open_dir(&mut self, path: impl AsRef<Path>) -> Result<Dir, Error>

Open a remote dir

pub fn dir_builder(&mut self) -> DirBuilder<'_>

Create a directory builder.

pub async fn create_dir(&mut self, path: impl AsRef<Path>) -> Result<(), Error>

Creates a new, empty directory at the provided path.

pub async fn remove_dir(&mut self, path: impl AsRef<Path>) -> Result<(), Error>

Removes an existing, empty directory.

pub async fn remove_file(&mut self, path: impl AsRef<Path>) -> Result<(), Error>

Removes a file from remote filesystem.

pub async fn canonicalize( &mut self, path: impl AsRef<Path> ) -> Result<PathBuf, Error>

Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved.

If the remote server supports the expand-path extension, then this method will also expand tilde characters (“~”) in the path. You can check it with Sftp::support_expand_path.

pub async fn hard_link( &mut self, src: impl AsRef<Path>, dst: impl AsRef<Path> ) -> Result<(), Error>

Creates a new hard link on the remote filesystem.

Precondition

Require extension hardlink

You can check it with Sftp::support_hardlink.

pub async fn symlink( &mut self, src: impl AsRef<Path>, dst: impl AsRef<Path> ) -> Result<(), Error>

Creates a new symlink on the remote filesystem.

pub async fn rename( &mut self, from: impl AsRef<Path>, to: impl AsRef<Path> ) -> Result<(), Error>

Renames a file or directory to a new name, replacing the original file if to already exists.

If the server supports the posix-rename extension, it will be used. You can check it with Sftp::support_posix_rename.

This will not work if the new name is on a different mount point.

pub async fn read_link( &mut self, path: impl AsRef<Path> ) -> Result<PathBuf, Error>

Reads a symbolic link, returning the file that the link points to.

pub async fn set_metadata( &mut self, path: impl AsRef<Path>, metadata: MetaData ) -> Result<(), Error>

Change the metadata of a file or a directory.

pub async fn set_permissions( &mut self, path: impl AsRef<Path>, perm: Permissions ) -> Result<(), Error>

Changes the permissions found on a file or a directory.

pub async fn metadata( &mut self, path: impl AsRef<Path> ) -> Result<MetaData, Error>

Given a path, queries the file system to get information about a file, directory, etc.

pub async fn symlink_metadata( &mut self, path: impl AsRef<Path> ) -> Result<MetaData, Error>

Queries the file system metadata for a path.

pub async fn read(&mut self, path: impl AsRef<Path>) -> Result<BytesMut, Error>

Reads the entire contents of a file into a bytes.

pub async fn write( &mut self, path: impl AsRef<Path>, content: impl AsRef<[u8]> ) -> Result<(), Error>

Open/Create a file for writing and write the entire contents into it.

Trait Implementations

impl Clone for Fs

fn clone(&self) -> Fs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Fs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.