Enum openssh::Error

#[non_exhaustive]
pub enum Error {
    Master(Error),
    Connect(Error),
    Ssh(Error),
    SshMux(Error),
    InvalidCommand,
    Remote(Error),
    Disconnected,
    RemoteProcessTerminated,
    Cleanup(Error),
    ChildIo(Error),
    CommandHasEnv,
    CommandHasCwd,
}

Errors that occur when interacting with a remote process.

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.

Master(Error)

The master connection failed.

Connect(Error)

Failed to establish initial connection to the remote host.

Ssh(Error)

Available on crate feature process-mux only.

Failed to run the ssh command locally.

SshMux(Error)

Available on crate feature native-mux only.

Failed to connect to the ssh multiplex server.

InvalidCommand

Available on crate feature native-mux only.

Invalid command that contains null byte.

Remote(Error)

The remote process failed.

Disconnected

The connection to the remote host was severed.

Note that for the process impl, this is a best-effort error, and it may instead signify that the remote process exited with an error code of 255.

You should call Session::check to verify if you get this error back.

RemoteProcessTerminated

Remote process is terminated.

It is likely to be that the process is terminated by signal.

NOTE that due to a fundamental design flaw in ssh multiplex protocol, there is no way to tell RemoteProcessTerminated from Disconnect.

If you really need to identify Disconnect, you can call session.check() after wait() returns RemoteProcessTerminated, however the ssh multiplex master could exit right after wait(), meaning the remote process actually is terminated instead of Disconnected.

It is thus recommended to create your own workaround for your particular use cases.

Cleanup(Error)

Failed to remove temporary dir where ssh socket and output is stored.

ChildIo(Error)

IO Error when creating/reading/writing from ChildStdin, ChildStdout, ChildStderr.

CommandHasEnv

The command has some env variables that it expects to carry over ssh. However, OverSsh does not support passing env variables over ssh.

CommandHasCwd

The command expects to be in a specific working directory in remote. However, OverSsh does not support setting a working directory for commands to be executed over ssh.

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)>

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(err: Error) -> Self

Converts to this type from the input type.