Enum Error

#[non_exhaustive]
pub enum Error {
    UnsupportedSftpProtocol {
        version: u32,
    },
    SftpServerHelloMsgTooLong {
        len: u32,
    },
    SftpServerFailure(ExitStatus),
    BackgroundTaskFailure(&'static &'static str),
    UnsupportedExtension(&'static &'static str),
    IOError(Error),
    FormatError(SshFormatError),
    AwaitableError(AwaitableError),
    BufferTooLong(TryFromIntError),
    InvalidResponseId {
        response_id: u32,
    },
    RecursiveErrors(Box<RecursiveError>),
    RecursiveErrors3(Box<RecursiveError3>),
    SftpError(SftpErrorKind, SftpErrMsg),
    InvalidResponse(&'static &'static str),
    HandleTooLong,
    TaskJoinError(JoinError),
    RemoteChildSpawnError(Error),
}

Error returned by openssh-sftp-client-lowlevel and openssh-sftp-client

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnsupportedSftpProtocol

Server speaks sftp protocol other than protocol 3.

Fields

version: u32

The minimal sftp protocol version the server supported.

SftpServerHelloMsgTooLong

Server returned a hello message that is too long.

Fields

len: u32

The length of the hello mesage

SftpServerFailure(ExitStatus)

This error is meant to be a dummy error created by user of this crate to indicate that the sftp-server run on remote server failed.

openssh-sftp-client would never return this error.

BackgroundTaskFailure(&'static &'static str)

This error is meant to be a dummy error created by user of this crate to indicate that the sftp-server run on remote server failed.

openssh-sftp-client would never return this error.

UnsupportedExtension(&'static &'static str)

This error is meant to be a dummy error created by user of this crate to indicate that the extension is not supported.

openssh-sftp-client would never return this error.

IOError(Error)

IO Error (Excluding io::ErrorKind::WouldBlock): {0}.

FormatError(SshFormatError)

Failed to serialize/deserialize the message: {0}.

AwaitableError(AwaitableError)

Error when waiting for response

BufferTooLong(TryFromIntError)

Sftp protocol can only send and receive at most u32::MAX data in one request.

InvalidResponseId

The response id is invalid.

The user can choose to log this error and continue operation.

Fields

response_id: u32

The invalid response id

RecursiveErrors(Box<RecursiveError>)

Raised 2 errors when cleaning up.

RecursiveErrors3(Box<RecursiveError3>)

Raised 3 errors when cleaning up.

SftpError(SftpErrorKind, SftpErrMsg)

Sftp server error

InvalidResponse(&'static &'static str)

Invalid response from the sftp-server

HandleTooLong

Handle returned by server is longer than the limit 256 bytes specified in sftp v3.

TaskJoinError(JoinError)

tokio join error

RemoteChildSpawnError(Error)

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: SshFormatError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: AwaitableError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<JoinError> for Error

fn from(source: JoinError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(source: TryFromIntError) -> Self

Converts to this type from the input type.