Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidConfig(Cow<'static, str>),
    Transport(TransportError),
    HostKey(HostKeyError),
    Authentication(AuthenticationError),
    Channel(ChannelError),
    CommandExit {
        exit: CommandExit,
    },
    Sftp(SftpError),
    Forwarding(ForwardingError),
    Timeout(TimeoutError),
    Cancelled(CancelledError),
    Disconnected(DisconnectedError),
    Unsupported(Cow<'static, str>),
    Io(Error),
    Ssh(SshError),
}

Error type used by russh-extra.

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.

InvalidConfig(Cow<'static, str>)

A builder or parser received invalid configuration.

Transport(TransportError)

SSH transport failed.

HostKey(HostKeyError)

Host-key verification failed.

Authentication(AuthenticationError)

Authentication was rejected or could not be attempted.

Channel(ChannelError)

A channel could not be opened or used.

CommandExit

A remote command exited unsuccessfully.

Fields

exit: CommandExit

Reported remote command exit.

Sftp(SftpError)

SFTP operation failed.

Forwarding(ForwardingError)

Forwarding operation failed.

Timeout(TimeoutError)

Operation timed out.

Cancelled(CancelledError)

Operation was cancelled.

Disconnected(DisconnectedError)

Remote peer disconnected.

Unsupported(Cow<'static, str>)

A requested operation is not implemented or not supported.

Io(Error)

Local I/O failed.

Ssh(SshError)

An unclassified lower-level SSH error occurred.

Implementations

impl Error

pub fn invalid_config(message: impl Into<Cow<'static, str>>) -> Self

Creates an invalid configuration error.

pub fn transport( kind: TransportErrorKind, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a transport error.

pub fn transport_with_source<E>( kind: TransportErrorKind, message: impl Into<Cow<'static, str>>, source: E, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates a transport error with a lower-level source.

pub fn host_key( kind: HostKeyErrorKind, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a host-key verification error.

pub fn host_key_with_source<E>( kind: HostKeyErrorKind, message: impl Into<Cow<'static, str>>, source: E, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates a host-key verification error with a lower-level source.

pub fn authentication(message: impl Into<Cow<'static, str>>) -> Self

Creates an authentication error.

pub fn authentication_kind( kind: AuthenticationErrorKind, message: impl Into<Cow<'static, str>>, ) -> Self

Creates an authentication error with a specific category.

pub fn authentication_with_source<E>( kind: AuthenticationErrorKind, message: impl Into<Cow<'static, str>>, source: E, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates an authentication error with a lower-level source.

pub fn channel(message: impl Into<Cow<'static, str>>) -> Self

Creates a channel error.

pub fn channel_kind( kind: ChannelErrorKind, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a channel error with a specific category.

pub fn channel_with_source<E>( kind: ChannelErrorKind, message: impl Into<Cow<'static, str>>, source: E, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates a channel error with a lower-level source.

pub fn command_exit(exit: CommandExit) -> Self

Creates a remote command exit error.

pub fn sftp(kind: SftpErrorKind, message: impl Into<Cow<'static, str>>) -> Self

Creates an SFTP error.

pub fn sftp_with_source<E>( kind: SftpErrorKind, message: impl Into<Cow<'static, str>>, source: E, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates an SFTP error with a lower-level source.

pub fn forwarding( kind: ForwardingErrorKind, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a forwarding error.

pub fn forwarding_with_source<E>( kind: ForwardingErrorKind, source: E, message: impl Into<Cow<'static, str>>, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates a forwarding error with a lower-level source.

pub fn timeout( operation: Operation, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a timeout error.

pub fn cancelled( operation: Operation, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a cancellation error.

pub fn disconnected( operation: Operation, message: impl Into<Cow<'static, str>>, ) -> Self

Creates a remote disconnect error.

pub fn unsupported(message: impl Into<Cow<'static, str>>) -> Self

Creates an unsupported operation error.

pub fn ssh_with_source<E>( message: impl Into<Cow<'static, str>>, source: E, ) -> Self

where E: StdError + Send + Sync + 'static,

Creates an unclassified lower-level SSH error with a source.

pub fn is_timeout(&self) -> bool

Returns whether this error is a timeout.

pub fn is_cancelled(&self) -> bool

Returns whether this error is a cancellation.

pub fn is_disconnected(&self) -> bool

Returns whether this error is a remote disconnect.

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<Box<dyn Error + Send + Sync>> for Error

fn from(source: BoxError) -> 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.