Enum ExitCode 

#[non_exhaustive]
pub enum ExitCode {
    Ok,
    UserError,
    SystemError,
    DependencyMissing,
    NotCargoWorkspace,
    ContractViolation,
    UnknownSubcommand,
    Signaled(u8),
}

Documented process exit codes returned by ready-set commands.

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.

Ok

Success.

UserError

The user’s input was invalid.

SystemError

An I/O, permission, or environmental error.

DependencyMissing

A required external tool was not found on PATH.

NotCargoWorkspace

A command requiring a cargo workspace was invoked outside one.

ContractViolation

A plugin violated the dispatcher↔plugin contract.

UnknownSubcommand

The dispatcher could not resolve the requested subcommand.

Signaled(u8)

A child process was terminated by signal N. The numeric exit code emitted to the OS is 128 + N, following the POSIX shell convention. Only meaningful on Unix; Windows children always have ExitStatus::code() == Some(_).

Implementations

impl ExitCode

pub const fn as_u8(self) -> u8

Return the numeric exit code as a u8.

Signaled(n) returns 128 + n, saturating at 255 for hypothetical signal numbers that would overflow.

Trait Implementations

impl Clone for ExitCode

fn clone(&self) -> ExitCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExitCode

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

Formats the value using the given formatter.

impl From<&Error> for ExitCode

fn from(value: &Error) -> Self

Converts to this type from the input type.

impl From<ExitCode> for ExitCode

fn from(value: ExitCode) -> Self

Converts to this type from the input type.

impl PartialEq for ExitCode

fn eq(&self, other: &ExitCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ExitCode

impl Eq for ExitCode

impl StructuralPartialEq for ExitCode