Enum openssh_sftp_client::Error

source · [−]

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

Variants (Non-exhaustive)

This enum is marked as 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`

Fields

version: u32

The minimal sftp protocol version the server supported.

Server speaks sftp protocol other than protocol 3.

`SftpServerHelloMsgTooLong`

Fields

len: u32

Server returned a hello message that is too long.

`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(Error)`

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

`AwaitableError(Error)`

Error when waiting for response

`BufferTooLong(TryFromIntError)`

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

`InvalidResponseId`

Fields

response_id: u32

The response id is invalid.

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

`RecursiveErrors(Box<(Error, Error)>)`

(OriginalError, RecursiveError)

`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.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter. Read more

impl Display for Error

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

Formats the value using the given formatter. Read more

impl Error for Error

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

The lower-level source of this error, if any. Read more

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred. Read more

1.0.0 · source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · source

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for Error

fn from(source: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(source: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(source: Error) -> Self

Performs the conversion.

impl From<TryFromIntError> for Error

fn from(source: TryFromIntError) -> Self

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl !UnwindSafe for Error

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.