Struct std::process::ExitStatusError

pub struct ExitStatusError(_);

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

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();

Implementations

impl ExitStatusError

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));

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 is 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());

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

impl Clone for ExitStatusError

fn clone(&self) -> ExitStatusError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExitStatusError

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

Formats the value using the given formatter.

impl Display for ExitStatusError

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

Formats the value using the given formatter.

impl Error for ExitStatusError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace #53487)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl ExitStatusExt for ExitStatusError

This is supported on Unix only.

fn from_raw(raw: i32) -> Self

Creates a new ExitStatus or ExitStatusError from the raw underlying integer status value from wait

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

If the process was terminated by a signal, returns that signal.

fn core_dumped(&self) -> bool

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

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

If the process was stopped by a signal, returns that signal.

fn continued(&self) -> bool

Whether the process was continued from a stopped status.

fn into_raw(self) -> i32

Returns the underlying raw wait status.

impl Into<ExitStatus> for ExitStatusError

fn into(self) -> ExitStatus

Converts this type into the (usually inferred) input type.

impl PartialEq<ExitStatusError> for ExitStatusError

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

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

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

This method tests for !=.

impl Copy for ExitStatusError

impl Eq for ExitStatusError

impl StructuralEq for ExitStatusError

impl StructuralPartialEq for ExitStatusError