Struct ExitStatus 

pub struct ExitStatus(pub c_int);

Number that summarizes the result of command execution.

An exit status is an integer returned from a utility (or command) when executed. It usually is a summarized result of the execution. Many utilities return an exit status of zero when successful and non-zero otherwise.

In the shell language, the special parameter $? expands to the exit status of the last executed command. Exit statuses also affect the behavior of some compound commands.

Tuple Fields

0: c_int

Implementations

impl ExitStatus

pub fn to_signal<S: System + ?Sized>( self, system: &S, exact: bool, ) -> Option<(Name, Number)>

Returns the signal name and number corresponding to the exit status.

This function is the inverse of the From<signal::Number> implementation for ExitStatus. It tries to find a signal name and number by offsetting the exit status by 384. If the offsetting does not result in a valid signal name and number, it additionally tries with 128 and 0 unless exact is true.

If self is not a valid signal exit status, this function returns None.

impl ExitStatus

pub const SUCCESS: ExitStatus

Exit status of 0: success

pub const FAILURE: ExitStatus

Exit status of 1: failure

pub const ERROR: ExitStatus

Exit status of 2: error severer than failure

pub const NOEXEC: ExitStatus

Exit Status of 126: command not executable

pub const NOT_FOUND: ExitStatus

Exit status of 127: command not found

pub const READ_ERROR: ExitStatus

Exit status of 128: unrecoverable read error

pub const fn is_successful(&self) -> bool

Returns true if and only if self is zero.

Trait Implementations

impl Clone for ExitStatus

fn clone(&self) -> ExitStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExitStatus

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

Formats the value using the given formatter.

impl Default for ExitStatus

fn default() -> ExitStatus

Returns the “default value” for a type.

impl Display for ExitStatus

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

Formats the value using the given formatter.

impl From<ExitStatus> for Result

fn from(exit_status: ExitStatus) -> Self

Converts to this type from the input type.

impl From<ExitStatus> for c_int

fn from(exit_status: ExitStatus) -> c_int

Converts to this type from the input type.

impl From<Number> for ExitStatus

Converts a signal number to the corresponding exit status.

POSIX requires the exit status to be greater than 128. The current implementation returns signal_number + 384.

See ExitStatus::to_signal for the reverse conversion.

fn from(number: Number) -> Self

Converts to this type from the input type.

impl From<ProcessResult> for ExitStatus

Converts ProcessResult to ExitStatus.

fn from(result: ProcessResult) -> Self

Converts to this type from the input type.

impl From<i32> for ExitStatus

fn from(value: c_int) -> ExitStatus

Converts to this type from the input type.

impl Hash for ExitStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ExitStatus

fn cmp(&self, other: &ExitStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ExitStatus

fn eq(&self, other: &ExitStatus) -> 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 PartialOrd for ExitStatus

fn partial_cmp(&self, other: &ExitStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Termination for ExitStatus

Converts the exit status to ExitCode.

Note that ExitCode only supports exit statuses in the range of 0 to 255. Only the lowest 8 bits of the exit status are used in the conversion.

fn report(self) -> ExitCode

Is called to get the representation of the value as status code. This status code is returned to the operating system.

impl TryFrom<ProcessState> for ExitStatus

Converts ProcessState to ExitStatus.

For the Running state, the conversion fails with RunningProcess.

type Error = RunningProcess

The type returned in the event of a conversion error.

fn try_from(state: ProcessState) -> Result<Self, RunningProcess>

Performs the conversion.

impl Copy for ExitStatus

impl Eq for ExitStatus

impl StructuralPartialEq for ExitStatus