Struct `ExitStatus`

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

Describes the result of a process after it has terminated.

This struct is used to represent the exit status or other termination of a child process. Child processes are created via the Command struct and their exit status is exposed through the status method, or the wait method of a Child process.

An ExitStatus represents every possible disposition of a process. On Unix this is the wait status. It is not simply an exit status (a value passed to exit).

For proper error reporting of failed processes, print the value of ExitStatus or ExitStatusError using their implementations of Display.

Differences from `ExitCode`

ExitCode is intended for terminating the currently running process, via the Termination trait, in contrast to ExitStatus, which represents the termination of a child process. These APIs are separate due to platform compatibility differences and their expected usage; it is not generally possible to exactly reproduce an ExitStatus from a child for the current process after the fact.

Fields

0: ExitStatus

Implementations

`impl ExitStatus`

fn exit_ok(&self) -> Result<(), ExitStatusError>

Was termination successful? Returns a Result.

Examples

#![feature(exit_status_error)]
# if cfg!(all(unix, not(all(target_vendor = "apple", not(target_os = "macos"))))) {
use std::process::Command;

let status = Command::new("ls")
    .arg("/dev/nonexistent")
    .status()
    .expect("ls command should execute successfully");

println!("ls: {status}");
status.exit_ok().expect_err("/dev/nonexistent could be listed!");
# } // cfg!(unix)

fn success(&self) -> bool

Was termination successful? Signal termination is not considered a success, and success is defined as a zero exit status.

Examples

use std::process::Command;

let status = Command::new("mkdir")
    .arg("projects")
    .status()
    .expect("mkdir command should execute successfully");

if status.success() {
    println!("'projects/' directory created");
} else {
    println!("failed to create 'projects/' directory: {status}");
}

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

Returns the exit code of the process, if any.

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. ExitStatusExt is an extension trait for extracting any such signal, and other details, from the ExitStatus.

Examples

use std::process::Command;

let status = Command::new("mkdir")
    .arg("projects")
    .status()
    .expect("mkdir command should execute successfully");

match status.code() {
    Some(code) => println!("Exited with status code: {code}"),
    None => println!("Process terminated by signal")
}