ExitStatusError in std::process - Rust (original) (raw)
Struct ExitStatusError
pub struct ExitStatusError(/* private fields */);🔬This is a nightly-only experimental API. (exit_status_error #84908)
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();🔬This is a nightly-only experimental API. (exit_status_error #84908)
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 fromExitStatusExt.
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 noExitStatusError. 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));🔬This is a nightly-only experimental API. (exit_status_error #84908)
Reports the exit code, if applicable, from an ExitStatusError, as a NonZero.
This is exactly like code(), except that it returns a [NonZero](../num/struct.NonZero.html "struct std::num::NonZero")<[i32](../primitive.i32.html "primitive 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)]
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());🔬This is a nightly-only experimental API. (exit_status_error #84908)
Converts an ExitStatusError (back) to an ExitStatus.
Returns the lower-level source of this error, if any. Read more
👎Deprecated since 1.42.0: use the Display impl or to_string()
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type-based access to context intended for error reports. Read more
Available on Unix only.
Creates a new ExitStatus or ExitStatusError from the raw underlying integer status value from wait Read more
If the process was terminated by a signal, returns that signal. Read more
If the process was terminated by a signal, says whether it dumped core.
If the process was stopped by a signal, returns that signal. Read more
Whether the process was continued from a stopped status. Read more
Returns the underlying raw wait status. Read more
Converts to this type from the input type.
Tests for self and other values to be equal, and is used by ==.
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.