# Struct std::process::ExitStatus

1.0.0 · source ·

    pub struct ExitStatus(/* private fields */);

Expand description

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.

## Implementations§

source§

### impl ExitStatus

source

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

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

Was termination successful? Returns a `Result`.

##### Examples

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

    let status = Command::new("ls")
        .arg("/dev/nonexistent")
        .status()
        .expect("ls could not be executed");

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

Run
source

#### 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}");
    }

Run
source

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

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

Run

## Trait Implementations§

source§

### impl Clone for ExitStatus

source§

#### fn clone(&self) -> ExitStatus

Returns a copy of the value. Read more
source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for ExitStatus

source§

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

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

### impl Default for ExitStatus

The default value is one which indicates successful completion.

source§

#### fn default() -> Self

Returns the “default value” for a type. Read more
source§

### impl Display for ExitStatus

source§

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

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

### impl ExitStatusExt for ExitStatus

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
1.12.0 · source§

### impl ExitStatusExt for ExitStatus

Available on Windows only.
source§

#### fn from_raw(raw: u32) -> Self

Creates a new `ExitStatus` from the raw underlying `u32` return value of a process.
source§

### impl From<ExitStatusError> for ExitStatus

source§

#### fn from(error: ExitStatusError) -> Self

Converts to this type from the input type.
source§

### impl PartialEq for ExitStatus

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
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 ExitStatus

source§

### impl Eq for ExitStatus

source§

### impl StructuralEq for ExitStatus

source§

### impl StructuralPartialEq for ExitStatus

## Auto Trait Implementations§

§

### impl RefUnwindSafe for ExitStatus

§

### impl Send for ExitStatus

§

### impl Sync for ExitStatus

§

### impl Unpin for ExitStatus

§

### impl UnwindSafe for ExitStatus

## 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.