Struct async_std::process::ExitStatus

pub struct 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 using its implementation of Display.

Implementations

impl ExitStatus

pub 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("failed to execute mkdir");

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

pub 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 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("failed to execute mkdir");

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

Trait Implementations

impl Clone for ExitStatus

pub fn clone(&self) -> ExitStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExitStatus

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

Formats the value using the given formatter.

impl Display for ExitStatus

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

Formats the value using the given formatter.

impl ExitStatusExt for ExitStatus

pub fn from_raw(raw: i32) -> ExitStatus

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

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

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

pub fn core_dumped(&self) -> bool

🔬 This is a nightly-only experimental API. (unix_process_wait_more)

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

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

🔬 This is a nightly-only experimental API. (unix_process_wait_more)

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

pub fn continued(&self) -> bool

🔬 This is a nightly-only experimental API. (unix_process_wait_more)

Whether the process was continued from a stopped status.

pub fn into_raw(self) -> i32

🔬 This is a nightly-only experimental API. (unix_process_wait_more)

Returns the underlying raw wait status.

impl PartialEq<ExitStatus> for ExitStatus

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

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

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

This method tests for !=.

impl Copy for ExitStatus

impl Eq for ExitStatus

impl StructuralEq for ExitStatus

impl StructuralPartialEq for ExitStatus