Struct openssh_sftp_client::Sftp

pub struct Sftp { /* private fields */ }

A file-oriented channel to a remote host.

Implementations

impl Sftp

pub async fn new<W: AsyncWrite + Send + 'static, R: AsyncRead + Send + 'static>(
    stdin: W,
    stdout: R,
    options: SftpOptions
) -> Result<Self, Error>

Create Sftp.

pub async fn close(self) -> Result<(), Error>

Close sftp connection

pub fn options(&self) -> OpenOptions<'_>

Return a new OpenOptions object.

pub async fn create(&self, path: impl AsRef<Path>) -> Result<File<'_>, Error>

Opens a file in write-only mode.

This function will create a file if it does not exist, and will truncate it if it does.

pub async fn open(&self, path: impl AsRef<Path>) -> Result<File<'_>, Error>

Attempts to open a file in read-only mode.

pub fn fs(&self) -> Fs<'_>

Fs defaults to the current working dir set by remote sftp-server, which usually is the home directory.

Trait Implementations

impl Debug for Sftp

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

Formats the value using the given formatter.

impl Drop for Sftp

fn drop(&mut self)

Executes the destructor for this type.