Struct std::process::ExitStatusError
source · [−]pub struct ExitStatusError(_);
Expand description
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();
RunImplementations
sourceimpl ExitStatusError
impl ExitStatusError
sourcepub fn code(&self) -> Option<i32>
pub 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)]
use std::process::Command;
let bad = Command::new("false").status().unwrap().exit_ok().unwrap_err();
assert_eq!(bad.code(), Some(1));
Runsourcepub fn code_nonzero(&self) -> Option<NonZeroI32>
pub fn code_nonzero(&self) -> Option<NonZeroI32>
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());
Runsourcepub fn into_status(&self) -> ExitStatus
pub fn into_status(&self) -> ExitStatus
Converts an ExitStatusError
(back) to an ExitStatus
.
Trait Implementations
sourceimpl Clone for ExitStatusError
impl Clone for ExitStatusError
sourcefn clone(&self) -> ExitStatusError
fn clone(&self) -> ExitStatusError
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ExitStatusError
impl Debug for ExitStatusError
sourceimpl Display for ExitStatusError
impl Display for ExitStatusError
sourceimpl Error for ExitStatusError
impl Error for ExitStatusError
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl ExitStatusExt for ExitStatusError
Available on Unix only.
impl ExitStatusExt for ExitStatusError
sourcefn from_raw(raw: i32) -> Self
fn from_raw(raw: i32) -> Self
Creates a new ExitStatus
or ExitStatusError
from the raw underlying integer status
value from wait
Read more
sourcefn signal(&self) -> Option<i32>
fn signal(&self) -> Option<i32>
If the process was terminated by a signal, returns that signal. Read more
sourcefn core_dumped(&self) -> bool
fn core_dumped(&self) -> bool
If the process was terminated by a signal, says whether it dumped core.
sourcefn stopped_signal(&self) -> Option<i32>
fn stopped_signal(&self) -> Option<i32>
If the process was stopped by a signal, returns that signal. Read more
sourceimpl Into<ExitStatus> for ExitStatusError
impl Into<ExitStatus> for ExitStatusError
sourcefn into(self) -> ExitStatus
fn into(self) -> ExitStatus
Converts this type into the (usually inferred) input type.
sourceimpl PartialEq<ExitStatusError> for ExitStatusError
impl PartialEq<ExitStatusError> for ExitStatusError
sourcefn eq(&self, other: &ExitStatusError) -> bool
fn eq(&self, other: &ExitStatusError) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ExitStatusError) -> bool
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
Auto Trait Implementations
impl RefUnwindSafe for ExitStatusError
impl Send for ExitStatusError
impl Sync for ExitStatusError
impl Unpin for ExitStatusError
impl UnwindSafe for ExitStatusError
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more