Enum Error 

#[non_exhaustive]
pub enum Error {
    Io(Error),
    Serde(Error),
    Transport(String),
    StillRunning,
    ShellExited,
    SessionPoisoned,
    PolicyDenied(String),
    Unsupported(String),
    Budget(String),
}

Errors returned by execkit.

#[non_exhaustive]: new variants may be added in a minor release without it being a breaking change, so downstream match on Error must include a wildcard arm.

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.

Io(Error)

Serde(Error)

Transport(String)

StillRunning

Command did not finish before the session timeout (still running, or waiting for input). The session is poisoned afterward (see below) - the pending command would corrupt subsequent reads.

ShellExited

The shell process exited and closed the session’s channel (for example the command ran exit). Distinct from a timeout: it surfaces immediately. The session is unusable; create a new one.

SessionPoisoned

The session is unusable: a prior command timed out while still running, so its later output would desync framing. Create a new session. (v0.x will replace poisoning with interrupt + resync.)

PolicyDenied(String)

Blocked by the advisory policy before reaching the shell.

Unsupported(String)

The operation is not supported for this session (e.g. checkpoints on a local session, or git missing on the remote).

Budget(String)

An output budget was invalid (e.g. a malformed grep regex).

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

Converts to this type from the input type.