Skip to main content

ExitCode

Struct ExitCode 

Source
pub struct ExitCode(/* private fields */);
Expand description

CLI exit code with semantic meaning.

Provides type-safe exit codes following Unix conventions. Success is 0, errors are non-zero with specific meanings.

§Examples

use mcp_execution_core::cli::ExitCode;

let code = ExitCode::SUCCESS;
assert_eq!(code.as_i32(), 0);
assert!(code.is_success());

let code = ExitCode::from_i32(1).unwrap();
assert!(!code.is_success());

// Outside the valid process exit code range (0..=255) is rejected.
assert!(ExitCode::from_i32(-1).is_none());
assert!(ExitCode::from_i32(256).is_none());

Implementations§

Source§

impl ExitCode

Source

pub const SUCCESS: Self

Successful execution (exit code 0).

§Examples
use mcp_execution_core::cli::ExitCode;

assert_eq!(ExitCode::SUCCESS.as_i32(), 0);
Source

pub const ERROR: Self

General error (exit code 1).

§Examples
use mcp_execution_core::cli::ExitCode;

assert_eq!(ExitCode::ERROR.as_i32(), 1);
Source

pub const INVALID_INPUT: Self

Invalid input or arguments (exit code 2).

§Examples
use mcp_execution_core::cli::ExitCode;

assert_eq!(ExitCode::INVALID_INPUT.as_i32(), 2);
Source

pub const SERVER_ERROR: Self

Server connection or communication error (exit code 3).

§Examples
use mcp_execution_core::cli::ExitCode;

assert_eq!(ExitCode::SERVER_ERROR.as_i32(), 3);
Source

pub const TIMEOUT: Self

Execution timeout or resource limit exceeded (exit code 4).

§Examples
use mcp_execution_core::cli::ExitCode;

assert_eq!(ExitCode::TIMEOUT.as_i32(), 4);
Source

pub const fn from_i32(code: i32) -> Option<Self>

Creates an exit code from an integer value.

Returns None if code falls outside 0..=255. This is not a universal OS-level ceiling — on Unix, std::process::exit truncates its argument to the low 8 bits, but on Windows it delivers the full i32 to the parent process via ExitProcess — so 0..=255 is this API’s own deliberate choice (matching every named const this type already defines, and the conventional Unix exit-code range this CLI targets), not something every platform enforces for it. Rejecting an out-of-range value here surfaces a construction mistake immediately rather than silently producing an ExitCode whose reported value could be misleading once actually reported to the OS.

§Examples
use mcp_execution_core::cli::ExitCode;

let code = ExitCode::from_i32(0).unwrap();
assert_eq!(code, ExitCode::SUCCESS);

assert!(ExitCode::from_i32(-1).is_none());
assert!(ExitCode::from_i32(256).is_none());
Source

pub const fn as_i32(&self) -> i32

Returns the exit code as an integer.

§Examples
use mcp_execution_core::cli::ExitCode;

assert_eq!(ExitCode::SUCCESS.as_i32(), 0);
assert_eq!(ExitCode::ERROR.as_i32(), 1);
Source

pub const fn is_success(&self) -> bool

Checks if the exit code represents success.

§Examples
use mcp_execution_core::cli::ExitCode;

assert!(ExitCode::SUCCESS.is_success());
assert!(!ExitCode::ERROR.is_success());

Trait Implementations§

Source§

impl Clone for ExitCode

Source§

fn clone(&self) -> ExitCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ExitCode

Source§

impl Debug for ExitCode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ExitCode

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for ExitCode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ExitCode

Source§

impl From<ExitCode> for i32

Source§

fn from(code: ExitCode) -> Self

Converts to this type from the input type.
Source§

impl Hash for ExitCode

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ExitCode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ExitCode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.