Struct `ExitStatusError`

pub struct ExitStatusError(pub(in ::process) ExitStatusError);

Describes the result of a process after it has failed

Produced by the .exit_ok method on ExitStatus.

Examples

#![feature(exit_status_error)]
# if cfg!(all(unix, not(target_os = "android"), not(all(target_vendor = "apple", not(target_os = "macos"))))) {
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();
# } // cfg!(unix)

Fields

0: ExitStatusError

Implementations

`impl ExitStatusError`

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

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)]
# #[cfg(all(unix, not(target_os = "android"), not(all(target_vendor = "apple", not(target_os = "macos")))))] {
use std::process::Command;

let bad = Command::new("false").status().unwrap().exit_ok().unwrap_err();
assert_eq!(bad.code(), Some(1));
# } // #[cfg(unix)]

fn code_nonzero(&self) -> Option<NonZero<i32>>

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

This is exactly like code(), except that it returns a [NonZero]<[i32]>.

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

# if cfg!(all(unix, not(target_os = "android"), not(all(target_vendor = "apple", not(target_os = "macos"))))) {
use std::num::NonZero;
use std::process::Command;

let bad = Command::new("false").status().unwrap().exit_ok().unwrap_err();
assert_eq!(bad.code_nonzero().unwrap(), NonZero::new(1).unwrap());
# } // cfg!(unix)

fn into_status(&self) -> ExitStatus