Struct proc_exit::Code

pub struct Code(_);

Process exit code.

Implementations

impl Code

pub const SUCCESS: Code

The process exited successfully.

pub const FAILURE: Code

Generic failure.

pub const UNKNOWN: Code

Catch-all exit code when the process exits for an unknown reason.

pub const USAGE_ERR: Code

The command was used incorrectly, e.g. with the wrong number of arguments, a bad flag, bad syntax in a parameter, or whatever.

pub const DATA_ERR: Code

The input data was incorrect in some way. This should only be used for user’s data and not system files.

pub const NO_INPUT: Code

An input file (not a system file) did not exist or was not readable. This could also include erros like “No message” to a mailer (if it cared to catch it).

pub const NO_USER: Code

The user specified did not exist. This might be used for mail adresses or remote logins.

pub const NO_HOST: Code

The host specified did not exist. This is used in mail addresses or network requests.

pub const SERVICE_UNAVAILABLE: Code

A service is unavailable. This can occur if a support program or file does not exist. This can also be used as a catch-all message when something you wanted to do doesn’t work, but you don’t know why.

pub const SOFTWARE_ERR: Code

An internal software error has been detected. This should be limited to non-operating system related errors if possible.

pub const OS_ERR: Code

An operating system error has been detected. This is intended to be used for such things as “cannot fork”, or “cannot create pipe”. It includes things like getuid(2) returning a user that does not exist in the passwd file.

pub const OS_FILE_ERR: Code

Some system file (e.g. /etc/passwd, /var/run/utmp) does not exist, cannot be opened, or has some sort of error (e.g. syntax error).

pub const CANT_CREAT: Code

A (user specified) output file cannot be created.

pub const IO_ERR: Code

An error occurred while doing I/O on some file.

pub const TEMP_FAIL: Code

Temporary failure, indicating something that is not really an error. For example that a mailer could not create a connection, and the request should be reattempted later.

pub const PROTOCOL_ERR: Code

The remote system returned something that was “not possible” during a protocol exchange.

pub const NO_PERM: Code

You did not have sufficient permission to perform the operation. This is not intended for file system problems, which should use NoInput or CantCreat, but rather for high level permissions.

pub const CONFIG_ERR: Code

Something was found in an unconfigured or misconfigured state.

pub const NOT_EXECUTABLE: Code

Command was found but is not executable by the shell.

pub const NOT_FOUND: Code

Usually indicates that the command was not found by the shell, or that the command is found but that a library it requires is not found.

pub const INVALID_EXIT: Code

Usually indicates that the command was not found by the shell, or that the command is found but that a library it requires is not found.

pub const SIGHUP: Code

The SIGHUP signal is sent to a process when its controlling terminal is closed.

pub const SIGINT: Code

The SIGINT signal is sent to a process by its controlling terminal when a user wishes to interrupt the process.

pub const SIGQUIT: Code

The SIGQUIT signal is sent to a process by its controlling terminal when a user quit from keyboard (Ctrl-. or, Ctrl-4 or, on the virtual console, the SysRq key)

pub const SIGILL: Code

The SIGILL signal is sent to a process by its controlling terminal when an illegal instruction is encountered

pub const SIGTRAP: Code

The SIGTRAP signal is sent to a process by its controlling terminal when there is a trace/breakpoint trap

pub const SIGABRT: Code

The SIGABRT signal is sent to a process by its controlling terminal when process abort signal

pub const SIGFPE: Code

The SIGFPE signal is sent to a process by its controlling terminal when there is an erroneous arithmetic operation

pub const SIGKILL: Code

The SIGKILL signal is sent to a process to cause it to terminate immediately. In contrast to SIGTERM and SIGINT, this signal cannot be caught or ignored, and the receiving process cannot perform any clean-up upon receiving this signal.

pub const SIGSEGV: Code

The SIGSEGV signal is sent to a process on invalid memory reference

pub const SIGPIPE: Code

The SIGPIPE signal is sent to a process when it attempts to write to a pipe without a process connected to the other end.

pub const SIGALRM: Code

The SIGALRM signal is sent to a process when the time limit specified in a call to a preceding alarm setting function (such as setitimer) elapses.

pub const SIGTERM: Code

The SIGTERM signal is sent to a process to request its termination. Unlike the SIGKILL signal, it can be caught and interpreted or ignored by the process.

pub const fn new(code: i32) -> Self

pub fn from_status(status: ExitStatus) -> Self

Converts std::process::ExitStatus to proc_exit::Code.

On Unix, if the process was terminated by a fatal signal, the corresponding signal exit code is returned.

pub const fn coerce(self) -> Option<Self>

Coerce the code to a portable value

pub const fn is_portable(self) -> bool

Test if provided exit code is portable across platforms.

While Windows has wider types for return codes, Unix OS's tend to only support 8-bits, stripping off the higher order bits.

pub fn process_exit(self) -> !

pub fn ok(self) -> Result<(), Exit>

pub fn into_exit(self) -> Exit

pub fn with_message<D: Display + 'static>(self, msg: D) -> Exit

pub const fn is_ok(self) -> bool

Determines if the provided std::process::ExitStatus was successful.

Example:

use std::process;

let exit_status = process::Command::new("true")
    .status()
    .expect("failed to run true(1)");
assert!(proc_exit::Code::from_status(exit_status).is_ok());

pub const fn is_err(self) -> bool

Determines if the provided std::process::ExitStatus was unsuccessful.

Example:

use std::process;

let exit_status = process::Command::new("false")
    .status()
    .expect("failed to run false(1)");
assert!(proc_exit::Code::from_status(exit_status).is_err());

pub const fn is_reserved(self) -> bool

Tests if the provided exit code is reserved, and has a special meaning in shells.

pub const fn raw(self) -> i32

Trait Implementations

impl Clone for Code

pub fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Code

impl Debug for Code

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

Formats the value using the given formatter.

impl Default for Code

pub fn default() -> Self

Returns the "default value" for a type.

impl Display for Code

Provides a user-friendly explanation of the exit code.

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

Formats the value using the given formatter.

impl Eq for Code

impl From<ErrorKind> for Code

pub fn from(kind: ErrorKind) -> Self

Performs the conversion.

impl From<ExitStatus> for Code

Converts std::process::ExitStatus to an exit code by looking at its ExitStatus::code() value.

On Unix, if the process was terminated by a fatal signal, the corresponding signal exit code is returned.

pub fn from(status: ExitStatus) -> Self

Performs the conversion.

impl From<i32> for Code

Converts an i32 primitive integer to an exit code.

pub fn from(n: i32) -> Self

Performs the conversion.

impl PartialEq<Code> for Code

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

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

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

This method tests for !=.

impl StructuralEq for Code

impl StructuralPartialEq for Code