Struct libssh_rs::Sftp

pub struct Sftp { /* private fields */ }

Implementations

impl Sftp

pub fn create_dir(&self, filename: &str, mode: mode_t) -> SshResult<()>

Create a directory. mode specifies the permission bits to use on the directory. They will be modified by the effective umask on the server.

pub fn canonicalize(&self, filename: &str) -> SshResult<String>

Canonicalize filename, resolving relative directory references and symlinks.

pub fn chmod(&self, filename: &str, mode: mode_t) -> SshResult<()>

Change the permissions of a file

pub fn chown(&self, filename: &str, owner: uid_t, group: gid_t) -> SshResult<()>

Change the ownership of a file.

pub fn read_link(&self, filename: &str) -> SshResult<String>

Read the payload of a symlink

pub fn set_metadata(
    &self,
    filename: &str,
    metadata: &SetAttributes
) -> SshResult<()>

Change certain metadata attributes of the named file.

pub fn metadata(&self, filename: &str) -> SshResult<Metadata>

Retrieve metadata for a file, traversing symlinks

pub fn symlink_metadata(&self, filename: &str) -> SshResult<Metadata>

Retrieve metadata for a file, without traversing symlinks.

pub fn rename(&self, filename: &str, new_name: &str) -> SshResult<()>

Rename a file from filename to new_name

pub fn remove_file(&self, filename: &str) -> SshResult<()>

Remove a file or an empty directory

pub fn remove_dir(&self, filename: &str) -> SshResult<()>

Remove an empty directory

pub fn symlink(&self, target: &str, dest: &str) -> SshResult<()>

Create a symlink on the server. target is the filename of the symlink to be created, and dest is the payload of the symlink.

pub fn open(
    &self,
    filename: &str,
    accesstype: c_int,
    mode: mode_t
) -> SshResult<SftpFile>

Open a file on the server. accesstype corresponds to the open(2) flags parameter and controls whether the file is opened for read/write and so on. mode specified the permission bits to use when creating a new file; they will be modified by the effective umask on the server side.

pub fn open_dir(&self, filename: &str) -> SshResult<SftpDir>

Open a directory to obtain directory entries

pub fn read_dir(&self, filename: &str) -> SshResult<Vec<Metadata>>

Convenience function that reads all of the directory entries into a Vec. If you need to deal with very large directories, you may wish to directly use open_dir and manually iterate the directory contents.

Trait Implementations

impl Drop for Sftp

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Sftp