Struct Code

pub struct Code(/* private fields */);

Process exit code.

Common exit codes:

• Code::SUCCESS
• Code::FAILURE
• bash::USAGE

Implementations

impl Code

Create a Code

pub const SUCCESS: Code

The process exited successfully.

pub const FAILURE: Code

Generic failure.

pub const fn new(code: i32) -> Self

Create a custom error code

pub fn from_status(status: ExitStatus) -> Self

Converts std::process::ExitStatus to Code.

On Unix, if the process was terminated by a fatal signal, the corresponding signal exit code is returned.

impl Code

Bubble up the exit Code

pub fn process_exit(self) -> !

exit now!

pub fn ok(self) -> ExitResult

Convert to Result

pub fn as_exit(self) -> Exit

Convert to Exit error type

pub fn with_message<D: Display + 'static>(self, msg: D) -> Exit

Add user-visible message (like an Error)

impl Code

Introspection and Integration

pub fn as_exit_code(self) -> Option<ExitCode>

Convert to ExitCode

pub const fn as_raw(self) -> i32

Convert to raw value

pub const fn as_portable(self) -> Option<u8>

Convert to portable, raw value

pub const fn is_ok(self) -> bool

Determines if the provided std::process::ExitStatus was successful.

Example:

use std::process;

let exit_status = process::Command::new("true")
    .status()
    .expect("failed to run true(1)");
assert!(proc_exit::Code::from_status(exit_status).is_ok());

pub const fn is_err(self) -> bool

Determines if the provided std::process::ExitStatus was unsuccessful.

Example:

use std::process;

let exit_status = process::Command::new("false")
    .status()
    .expect("failed to run false(1)");
assert!(proc_exit::Code::from_status(exit_status).is_err());

pub const fn is_portable(self) -> bool

Test if provided exit code is portable across platforms.

While Windows has wider types for return codes, Unix OS’s tend to only support 8-bits, stripping off the higher order bits.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl Default for Code

fn default() -> Self

Returns the “default value” for a type.

impl From<ExitStatus> for Code

Converts std::process::ExitStatus to an exit code by looking at its ExitStatus::code() value.

On Unix, if the process was terminated by a fatal signal, the corresponding signal exit code is returned.

fn from(status: ExitStatus) -> Self

Converts to this type from the input type.

impl From<i32> for Code

Converts an i32 primitive integer to an exit code.

fn from(n: i32) -> Self

Converts to this type from the input type.

impl PartialEq for Code

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

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 Copy for Code

impl Eq for Code

impl StructuralPartialEq for Code