Enum Error

pub enum Error {
    InvalidOptions(String),
    AuthFailed {
        remaining_methods: MethodSet,
        partial_success: bool,
    },
    Io {
        file: PathBuf,
        source: Error,
    },
    UncleanExit,
    RemoteApplicationFailure {
        status_code: u32,
    },
    SshProtocol(Error),
    SshFormat(Error),
    Agent(AgentAuthError),
    Serialization(Error),
}

SSH communication error.

Variants

InvalidOptions(String)

Invalid options used.

AuthFailed

Authentication failed.

Fields

remaining_methods: MethodSet

The server suggests to proceed with these authentication methods.

partial_success: bool

The server says that though authentication method has been accepted, further authentication is required.

Io

I/O error occurred.

Fields

file: PathBuf

File being processed.

This field will be empty (PathBuf::new) if the error was encountered when processing generic I/O streams.

source: Error

Source error.

UncleanExit

The remote program did not exit cleanly.

RemoteApplicationFailure

The remote application returned a non-zero status code.

Fields

status_code: u32

Status code returned by the application.

SshProtocol(Error)

Internal russh protocol error.

SshFormat(Error)

SSH format error.

Agent(AgentAuthError)

Internal russh client agent error.

Serialization(Error)

JSON serialization 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<AgentAuthError> for Error

fn from(source: AgentAuthError) -> 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<Error> for Error

fn from(source: Error) -> 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<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.