Struct openssh::RemoteFile

pub struct RemoteFile<'s> { /* fields omitted */ }

A handle to a remote file.

If you opened this file for reading (with Sftp::read_from), you can read from it with std::io::Read. If you opened it for writing (with Sftp::write_to), you can write to it with std::io::Write.

Note that because we are operating against a remote host, errors may take a while to propagate. The various methods on RemoteFile will generally attempt to first check that the file you are trying to access can indeed be accessed in that way, but some errors may not become visible until you call close. In particular, the connection between you and the remote host may buffer bytes, so your write may report that some number of bytes have been successfully written, even though the remote disk is full. Or the file you are reading from may have been removed between when read_from checks that it exists and when it actually tries to read the first byte. For that reason, you should make sure to call close to observe any errors that may have occurred when operating on the remote file.

Implementations

impl<'_> RemoteFile<'_>

pub async fn close(__arg0: Self) -> Result<(), Error>

Close the handle to the remote file.

If the remote file was opened for reading, this will also call flush.

When you close the remote file, any errors on the remote end will also be propagated. This means that you could see errors about remote files not existing, or disks being full, only at the time when you call close.

Trait Implementations

impl<'_> AsyncRead for RemoteFile<'_>

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<'_> AsyncWrite for RemoteFile<'_>

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl<'s> Debug for RemoteFile<'s>

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

Formats the value using the given formatter.