Expand description

Highlevle API of sftp client

All async functions in this module are cancel safe.

Internally, this is archived by first writing requests into a write buffer containing bytes::Bytes and then flush all buffers at once periodically to archive cancel safety and improve efficiencies.

However, cancelling the future does not actually has any effect, since the requests are sent regardless of the cancellation.

Thus, if you cancel a future that changes the remote filesystem in any way, then the change would still happen regardless.

Structs

A token which can be used to signal a cancellation request to one or more tasks.

Remote Directory

Builder for new directory to create.

Entries returned by the ReadDir.

A reference to the remote file.

A structure representing a type of file with accessors for each file type. It is returned by MetaData::file_type method.

A struct used to perform operations on remote filesystem.

Metadata information about a file.

Options and flags which can be used to configure how a file is opened.

Representation of the various permissions on a file.

Reads the the entries in a directory.

A file-oriented channel to a remote host.

Options when creating super::Sftp.

File that implements AsyncRead, AsyncBufRead, AsyncSeek and AsyncWrite, which is compatible with tokio::fs::File.

Default value is 1970-01-01 00:00:00 UTC.

Enums

Constants

The default length of the buffer used in TokioCompatFile.

The default maximum length of the buffer that can be created in AsyncRead implementation of TokioCompatFile.

Functions

Maximum amount of data that can writen atomically.

Type Definitions

This type is renamed to TokioCompatFile.