Enum SysexitsError

#[repr(u8)]
pub enum SysexitsError {
    EX_OK = 0,
    EX_USAGE = 64,
    EX_DATAERR = 65,
    EX_NOINPUT = 66,
    EX_NOUSER = 67,
    EX_NOHOST = 68,
    EX_UNAVAILABLE = 69,
    EX_SOFTWARE = 70,
    EX_OSERR = 71,
    EX_OSFILE = 72,
    EX_CANTCREAT = 73,
    EX_IOERR = 74,
    EX_TEMPFAIL = 75,
    EX_PROTOCOL = 76,
    EX_NOPERM = 77,
    EX_CONFIG = 78,
}

Standard <sysexits.h> preferable exit codes for programs on Unix systems.

Quoting the rationale given in the sysexits(3) man page on BSD systems:

According to style(9), it is not a good practice to call exit(3) with arbitrary values to indicate a failure condition when ending a program. Instead, the pre-defined exit codes from sysexits should be used, so the caller of the process can get a rough estimation about the failure class without looking up the source code.

Variants

EX_OK = 0

Successful termination.

EX_USAGE = 64

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

EX_DATAERR = 65

The input data was incorrect in some way.

This should only be used for user’s data and not system files.

EX_NOINPUT = 66

An input file (not a system file) did not exist or was not readable.

This could also include errors like “No message” to a mailer (if it cared to catch it).

EX_NOUSER = 67

The user specified did not exist.

This might be used for mail addresses or remote logins.

EX_NOHOST = 68

The host specified did not exist.

This is used in mail addresses or network requests.

EX_UNAVAILABLE = 69

A service is unavailable.

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

EX_SOFTWARE = 70

An internal software error has been detected.

This should be limited to non-operating system related errors as possible.

EX_OSERR = 71

An operating system error has been detected.

This is intended to be used for such things as “cannot fork”, “cannot create pipe”, or the like. It includes things like getuid returning a user that does not exist in the /etc/passwd file.

EX_OSFILE = 72

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

EX_CANTCREAT = 73

A (user specified) output file cannot be created.

EX_IOERR = 74

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

EX_TEMPFAIL = 75

Temporary failure, indicating something that is not really an error.

In sendmail, this means that a mailer (e.g.) could not create a connection, and the request should be reattempted later.

EX_PROTOCOL = 76

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

EX_NOPERM = 77

You did not have sufficient permission to perform the operation.

This is not intended for file system problems, which should use EX_NOINPUT or EX_CANTCREAT, but rather for higher level permissions.

EX_CONFIG = 78

Something was found in an unconfigured or misconfigured state.

Implementations

impl SysexitsError

pub fn is_success(&self) -> bool

pub fn is_failure(&self) -> bool

pub fn as_u8(&self) -> u8

pub fn as_i32(&self) -> i32

pub fn as_str(&self) -> &'static str

pub fn as_exit_code(&self) -> ExitCode

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

pub fn name(&self) -> &'static str

pub fn summary(&self) -> &'static str

Trait Implementations

impl Clone for SysexitsError

fn clone(&self) -> SysexitsError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SysexitsError

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

Formats the value using the given formatter.

impl Default for SysexitsError

fn default() -> SysexitsError

Returns the “default value” for a type.

impl Display for SysexitsError

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

Formats the value using the given formatter.

impl Error for SysexitsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<&Box<dyn Error>> for SysexitsError

fn from(error: &Box<dyn Error>) -> SysexitsError

Converts to this type from the input type.

impl From<&Error> for SysexitsError

fn from(error: &Error) -> SysexitsError

Converts to this type from the input type.

impl From<Box<dyn Error>> for SysexitsError

fn from(error: Box<dyn Error>) -> SysexitsError

Converts to this type from the input type.

impl From<Error> for SysexitsError

fn from(error: Error) -> SysexitsError

Converts to this type from the input type.

impl FromStr for SysexitsError

type Err = ()

The associated error which can be returned from parsing.

fn from_str( input: &str, ) -> Result<SysexitsError, <SysexitsError as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SysexitsError

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SysexitsError

fn cmp(&self, other: &SysexitsError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SysexitsError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SysexitsError

fn partial_cmp(&self, other: &SysexitsError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Termination for SysexitsError

fn report(self) -> ExitCode

Is called to get the representation of the value as status code. This status code is returned to the operating system.

impl TryFrom<ExitStatus> for SysexitsError

type Error = Option<i32>

The type returned in the event of a conversion error.

fn try_from( status: ExitStatus, ) -> Result<SysexitsError, <SysexitsError as TryFrom<ExitStatus>>::Error>

Performs the conversion.

impl TryFrom<i32> for SysexitsError

type Error = i32

The type returned in the event of a conversion error.

fn try_from( code: i32, ) -> Result<SysexitsError, <SysexitsError as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<u8> for SysexitsError

type Error = u8

The type returned in the event of a conversion error.

fn try_from( code: u8, ) -> Result<SysexitsError, <SysexitsError as TryFrom<u8>>::Error>

Performs the conversion.

impl Copy for SysexitsError

impl Eq for SysexitsError

impl StructuralPartialEq for SysexitsError