1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
//! Preferred system exit codes as defined by sysexits.h
//!
//! Exit code constants intended to be passed to
//! `std::env::set_exit_status!()` or `std::process::exit()`
//!
//! # Example:
//! ```
//! use exitcode;
//!
//! ::std::process::exit(exitcode::OK);
//! ```
/// Successful exit
pub const OK: i32 = 0;
/// The command was used incorrectly, e.g., with the
/// wrong number of arguments, a bad flag, a bad syntax
/// in a parameter, etc.
pub const USAGE: i32 = 64;
/// The input data was incorrect in some way. This
/// should only be used for user's data and not system
/// files.
pub const DATAERR: i32 = 65;
/// 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).
pub const NOINPUT: i32 = 66;
/// The user specified did not exist. This might be
/// used for mail addresses or remote logins.
pub const NOUSER: i32 = 67;
/// The host specified did not exist. This is used in
/// mail addresses or network requests.
pub const NOHOST: i32 = 68;
/// A service is unavailable. This can occur if a sup
/// port 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.
pub const UNAVAILABLE: i32 = 69;
/// An internal software error has been detected. This
/// should be limited to non-operating system related
/// errors as possible.
pub const SOFTWARE: i32 = 70;
/// 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 passwd file.
pub const OSERR: i32 = 71;
/// 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).
pub const OSFILE: i32 = 72;
/// A (user specified) output file cannot be created.
pub const CANTCREAT: i32 = 73;
/// An error occurred while doing I/O on some file.
pub const IOERR: i32 = 74;
/// 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.
pub const TEMPFAIL: i32 = 75;
/// The remote system returned something that was
/// "not possible" during a protocol exchange.
pub const PROTOCOL: i32 = 76;
/// 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 higher level permissions.
pub const NOPERM: i32 = 77;
/// Something was found in an unconfigured or misconfigured state.
pub const CONFIG: i32 = 78;
/// Check if exit code given by `code` is successful
///
/// # Example:
/// ```
/// use exitcode;
/// assert!(exitcode::is_success(exitcode::OK));
/// assert!(!exitcode::is_success(exitcode::USAGE));
/// ```
/// Check if exit code given by `code` is an error
///
/// # Example:
/// ```
/// use exitcode;
/// assert!(exitcode::is_error(exitcode::USAGE));
/// assert!(!exitcode::is_error(exitcode::OK));
/// ```