pub struct ExitStatusError(/* private fields */);
🔬This is a nightly-only experimental API. (exit_status_error #84908)
Expand description

Describes the result of a process after it has failed

Produced by the .exit_ok method on ExitStatus.

§Examples

#![feature(exit_status_error)]
use std::process::{Command, ExitStatusError};

fn run(cmd: &str) -> Result<(),ExitStatusError> {
    Command::new(cmd).status().unwrap().exit_ok()?;
    Ok(())
}

run("true").unwrap();
run("false").unwrap_err();
Run

Implementations§

source§

impl ExitStatusError

source

pub fn code(&self) -> Option<i32>

🔬This is a nightly-only experimental API. (exit_status_error #84908)

Reports the exit code, if applicable, from an ExitStatusError.

In Unix terms the return value is the exit status: the value passed to exit, if the process finished by calling exit. Note that on Unix the exit status is truncated to 8 bits, and that values that didn’t come from a program’s call to exit may be invented by the runtime system (often, for example, 255, 254, 127 or 126).

On Unix, this will return None if the process was terminated by a signal. If you want to handle such situations specially, consider using methods from ExitStatusExt.

If the process finished by calling exit with a nonzero value, this will return that exit status.

If the error was something else, it will return None.

If the process exited successfully (ie, by calling exit(0)), there is no ExitStatusError. So the return value from ExitStatusError::code() is always nonzero.

§Examples
#![feature(exit_status_error)]
use std::process::Command;

let bad = Command::new("false").status().unwrap().exit_ok().unwrap_err();
assert_eq!(bad.code(), Some(1));
Run
source

pub fn code_nonzero(&self) -> Option<NonZeroI32>

🔬This is a nightly-only experimental API. (exit_status_error #84908)

Reports the exit code, if applicable, from an ExitStatusError, as a NonZero

This is exactly like code(), except that it returns a NonZeroI32.

Plain code, returning a plain integer, is provided because it is often more convenient. The returned value from code() is indeed also nonzero; use code_nonzero() when you want a type-level guarantee of nonzeroness.

§Examples
#![feature(exit_status_error)]
use std::num::NonZeroI32;
use std::process::Command;

let bad = Command::new("false").status().unwrap().exit_ok().unwrap_err();
assert_eq!(bad.code_nonzero().unwrap(), NonZeroI32::try_from(1).unwrap());
Run
source

pub fn into_status(&self) -> ExitStatus

🔬This is a nightly-only experimental API. (exit_status_error #84908)

Converts an ExitStatusError (back) to an ExitStatus.

Trait Implementations§

source§

impl Clone for ExitStatusError

source§

fn clone(&self) -> ExitStatusError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ExitStatusError

source§

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

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

impl Display for ExitStatusError

source§

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

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

impl Error for ExitStatusError

1.30.0 · source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type based access to context intended for error reports. Read more
source§

impl ExitStatusExt for ExitStatusError

Available on Unix only.
source§

fn from_raw(raw: i32) -> Self

Creates a new ExitStatus or ExitStatusError from the raw underlying integer status value from wait Read more
source§

fn signal(&self) -> Option<i32>

If the process was terminated by a signal, returns that signal. Read more
source§

fn core_dumped(&self) -> bool

If the process was terminated by a signal, says whether it dumped core.
source§

fn stopped_signal(&self) -> Option<i32>

If the process was stopped by a signal, returns that signal. Read more
source§

fn continued(&self) -> bool

Whether the process was continued from a stopped status. Read more
source§

fn into_raw(self) -> i32

Returns the underlying raw wait status. Read more
source§

impl From<ExitStatusError> for ExitStatus

source§

fn from(error: ExitStatusError) -> Self

Converts to this type from the input type.
source§

impl PartialEq for ExitStatusError

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for ExitStatusError

source§

impl Eq for ExitStatusError

source§

impl StructuralEq for ExitStatusError

source§

impl StructuralPartialEq for ExitStatusError

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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 Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

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

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

§

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 Twhere U: TryFrom<T>,

§

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.