Struct SftpFs 

pub struct SftpFs<S>
where
    S: SshSession,
{ /* private fields */ }

Sftp “filesystem” client

Implementations

impl SftpFs<LibSsh2Session>

pub fn libssh2(opts: SshOpts) -> Self

Available on crate feature libssh2 only.

Constructs a new SftpFs instance with the libssh2 backend.

impl SftpFs<LibSshSession>

pub fn libssh(opts: SshOpts) -> Self

Available on crate feature libssh only.

Constructs a new SftpFs instance with the libssh backend.

impl<S> SftpFs<S>

where S: SshSession,

pub fn session(&mut self) -> Option<&mut S>

Get a reference to current session value.

pub fn sftp(&mut self) -> Option<&mut S::Sftp>

Get a reference to current sftp value.

Trait Implementations

impl From<SshOpts> for SftpFs<LibSsh2Session>

fn from(opts: SshOpts) -> Self

Converts to this type from the input type.

impl From<SshOpts> for SftpFs<LibSshSession>

fn from(opts: SshOpts) -> Self

Converts to this type from the input type.

impl<S> RemoteFs for SftpFs<S>

where S: SshSession,

fn connect(&mut self) -> RemoteResult<Welcome>

Connect to the remote server and authenticate. Can return banner / welcome message on success. If client has already established connection, then RemoteErrorType::AlreadyConnected error is returned.

fn disconnect(&mut self) -> RemoteResult<()>

Disconnect from the remote server

fn is_connected(&mut self) -> bool

Gets whether the client is connected to remote

fn pwd(&mut self) -> RemoteResult<PathBuf>

Get working directory

fn change_dir(&mut self, dir: &Path) -> RemoteResult<PathBuf>

Change working directory. Returns the realpath of new directory

fn list_dir(&mut self, path: &Path) -> RemoteResult<Vec<File>>

List directory entries at specified path

fn stat(&mut self, path: &Path) -> RemoteResult<File>

Stat file at specified path and return File

fn setstat(&mut self, path: &Path, metadata: Metadata) -> RemoteResult<()>

Set metadata for file at specified path

fn exists(&mut self, path: &Path) -> RemoteResult<bool>

Returns whether file at specified path exists.

fn remove_file(&mut self, path: &Path) -> RemoteResult<()>

Remove file at specified path. Fails if is not a file or doesn’t exist

fn remove_dir(&mut self, path: &Path) -> RemoteResult<()>

Remove directory at specified path Directory is removed only if empty

fn remove_dir_all(&mut self, path: &Path) -> RemoteResult<()>

Removes a directory at this path, after removing all its contents. Use carefully!

fn create_dir(&mut self, path: &Path, mode: UnixPex) -> RemoteResult<()>

Create a directory at path with specified mode.

fn symlink(&mut self, path: &Path, target: &Path) -> RemoteResult<()>

Create a symlink at path pointing at target

fn copy(&mut self, src: &Path, dest: &Path) -> RemoteResult<()>

Copy src to dest

fn mov(&mut self, src: &Path, dest: &Path) -> RemoteResult<()>

move file/directory from src to dest

fn exec(&mut self, cmd: &str) -> RemoteResult<(u32, String)>

Execute a command on remote host if supported by host. Returns command exit code and output (stdout)

fn append( &mut self, path: &Path, metadata: &Metadata, ) -> RemoteResult<WriteStream>

Open file at path for appending data. If the file doesn’t exist, the file is created.

fn create( &mut self, path: &Path, metadata: &Metadata, ) -> RemoteResult<WriteStream>

Create file at path for write. If the file already exists, its content will be overwritten

fn open(&mut self, path: &Path) -> RemoteResult<ReadStream>

Open file at specified path for read.

fn append_file( &mut self, path: &Path, metadata: &Metadata, reader: Box<dyn Read + Send>, ) -> RemoteResult<u64>

Blocking implementation of RemoteFs::append This method SHOULD be implemented ONLY when streams are not supported by the current file transfer. The developer using the client should FIRST try with create followed by on_written If the function returns error of kind RemoteErrorType::UnsupportedFeature, then he should call this function. In case of success, returns the amount of bytes written to the remote file

fn create_file( &mut self, path: &Path, metadata: &Metadata, reader: Box<dyn Read + Send>, ) -> RemoteResult<u64>

Blocking implementation of RemoteFs::create This method SHOULD be implemented ONLY when streams are not supported by the current file transfer. The developer using the client should FIRST try with create followed by on_written If the function returns error of kind RemoteErrorType::UnsupportedFeature, then he should call this function. In case of success, returns the amount of bytes written to the remote file

fn open_file( &mut self, src: &Path, dest: Box<dyn Write + Send>, ) -> RemoteResult<u64>

Blocking implementation of RemoteFs::open This method SHOULD be implemented ONLY when streams are not supported by the current file transfer. (since it would work thanks to the default implementation) The developer using the client should FIRST try with RemoteFs::open followed by RemoteFs::on_read If the function returns error of kind RemoteErrorType::UnsupportedFeature, then he should call this function. In case of success, returns the amount of bytes written to the local stream

fn on_written(&mut self, _writable: WriteStream) -> Result<(), RemoteError>

Finalize RemoteFs::create and RemoteFs::append methods. This method must be implemented only if necessary; in case you don’t need it, just return Ok The purpose of this method is to finalize the connection with the peer when writing data. This is necessary for some protocols such as FTP. You must call this method each time you want to finalize the write of the remote file.

fn on_read(&mut self, _readable: ReadStream) -> Result<(), RemoteError>

Finalize RemoteFs::open method. This method must be implemented only if necessary; in case you don’t need it, just return Ok The purpose of this method is to finalize the connection with the peer when reading data. This might be necessary for some protocols. You must call this method each time you want to finalize the read of the remote file.

fn find(&mut self, search: &str) -> Result<Vec<File>, RemoteError>

Find files from current directory (in all subdirectories) whose name matches the provided search Search supports wildcards (‘?’, ‘*’)

fn iter_search( &mut self, dir: &Path, filter: &WildMatchPattern<'*', '?'>, ) -> Result<Vec<File>, RemoteError>

Search recursively in dir for file matching the wildcard.