├── .gitignore ├── .travis.yml ├── Cargo.toml ├── LICENSE ├── README.md ├── examples └── basic.rs └── src └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | 5 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries 6 | # More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock 7 | Cargo.lock 8 | 9 | # These are backup files generated by rustfmt 10 | **/*.rs.bk 11 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - stable 4 | - beta 5 | - nightly 6 | matrix: 7 | allow_failures: 8 | - rust: nightly 9 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "exitcode" 3 | version = "1.1.2" 4 | authors = ["Ben Wilber "] 5 | description = "Preferred system exit codes as defined by sysexits.h" 6 | documentation = "https://docs.rs/exitcode" 7 | homepage = "https://github.com/benwilber/exitcode" 8 | repository = "https://github.com/benwilber/exitcode" 9 | readme = "README.md" 10 | keywords = ["sysexits", "exitcode"] 11 | categories = ["os", "command-line-interface"] 12 | license = "Apache-2.0" 13 | 14 | [dependencies] 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![ghit.me](https://ghit.me/badge.svg?repo=benwilber/exitcode)](https://ghit.me/repo/benwilber/exitcode) [![Build Status](https://travis-ci.org/benwilber/exitcode.svg?branch=master)](https://travis-ci.org/benwilber/exitcode) [![Crates.io](https://img.shields.io/crates/v/exitcode.svg)](https://crates.io/crates/exitcode) 2 | 3 | # exitcode 4 | System exit code constants as defined by [sysexits.h](https://www.freebsd.org/cgi/man.cgi?query=sysexits&apropos=0&sektion=0&manpath=FreeBSD+4.3-RELEASE&format=html) 5 | 6 | Documentation is available [here](https://docs.rs/exitcode) 7 | 8 | # Installing from [crates.io](https://crates.io/crates/exitcode) 9 | ``` 10 | [dependencies] 11 | exitcode = "1.1.2" 12 | ``` 13 | 14 | # Example 15 | ```rust 16 | extern crate exitcode; 17 | 18 | use std::process; 19 | 20 | pub fn parse_int_or_return_error_exitcode(s: String) -> Result { 21 | match s.parse::() { 22 | Ok(i) => Ok(i), 23 | Err(_) => Err(exitcode::USAGE) 24 | } 25 | 26 | } 27 | 28 | pub fn main() { 29 | 30 | match parse_int_or_return_error_exitcode("123".to_string()) { 31 | Ok(i) => println!("Parsed: {}", i), 32 | Err(code) => { 33 | println!("Parse error. Exiting with code: {}", code); 34 | process::exit(code); 35 | } 36 | } 37 | 38 | match parse_int_or_return_error_exitcode("foo".to_string()) { 39 | Ok(i) => println!("Parsed: {}", i), 40 | Err(code) => { 41 | println!("Parse error. Exiting with code: {}", code); 42 | process::exit(code); 43 | } 44 | } 45 | 46 | println!("Exiting with code: {}", exitcode::OK); 47 | process::exit(exitcode::OK); 48 | 49 | } 50 | ``` 51 | -------------------------------------------------------------------------------- /examples/basic.rs: -------------------------------------------------------------------------------- 1 | extern crate exitcode; 2 | 3 | use std::process; 4 | use std::io::{Write, stderr}; 5 | 6 | pub fn parse_int_or_return_error_exitcode(s: &str) -> Result { 7 | match s.parse::() { 8 | Ok(i) => Ok(i), 9 | Err(_) => Err(exitcode::USAGE) 10 | } 11 | } 12 | 13 | pub fn main() { 14 | match parse_int_or_return_error_exitcode("foo") { 15 | Ok(i) => { 16 | println!("Parsed: {}", i); 17 | process::exit(exitcode::OK); 18 | }, 19 | Err(code) => { 20 | writeln!(stderr(), "Parse error. Exiting with code: {}", code).unwrap(); 21 | process::exit(code); 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! Preferred system exit codes as defined by sysexits.h 2 | //! 3 | //! Exit code constants intended to be passed to 4 | //! `std::process::exit()` 5 | //! 6 | //! # Example: 7 | //! ``` 8 | //! extern crate exitcode; 9 | //! 10 | //! ::std::process::exit(exitcode::OK); 11 | //! ``` 12 | 13 | /// Alias for the numeric type that holds system exit codes. 14 | pub type ExitCode = i32; 15 | 16 | /// Successful exit 17 | pub const OK: ExitCode = 0; 18 | 19 | /// The command was used incorrectly, e.g., with the 20 | /// wrong number of arguments, a bad flag, a bad syntax 21 | /// in a parameter, etc. 22 | pub const USAGE: ExitCode = 64; 23 | 24 | /// The input data was incorrect in some way. This 25 | /// should only be used for user's data and not system 26 | /// files. 27 | pub const DATAERR: ExitCode = 65; 28 | 29 | /// An input file (not a system file) did not exist or 30 | /// was not readable. This could also include errors 31 | /// like "No message" to a mailer (if it cared to 32 | /// catch it). 33 | pub const NOINPUT: ExitCode = 66; 34 | 35 | /// The user specified did not exist. This might be 36 | /// used for mail addresses or remote logins. 37 | pub const NOUSER: ExitCode = 67; 38 | 39 | /// The host specified did not exist. This is used in 40 | /// mail addresses or network requests. 41 | pub const NOHOST: ExitCode = 68; 42 | 43 | /// A service is unavailable. This can occur if a 44 | /// support program or file does not exist. This can also 45 | /// be used as a catchall message when something you 46 | /// wanted to do doesn't work, but you don't know why. 47 | pub const UNAVAILABLE: ExitCode = 69; 48 | 49 | /// An internal software error has been detected. This 50 | /// should be limited to non-operating system related 51 | /// errors as possible. 52 | pub const SOFTWARE: ExitCode = 70; 53 | 54 | /// An operating system error has been detected. This 55 | /// is intended to be used for such things as "cannot 56 | /// fork", "cannot create pipe", or the like. It 57 | /// includes things like getuid returning a user that 58 | /// does not exist in the passwd file. 59 | pub const OSERR: ExitCode = 71; 60 | 61 | /// Some system file (e.g., /etc/passwd, /var/run/utmp, 62 | /// etc.) does not exist, cannot be opened, or has some 63 | /// sort of error (e.g., syntax error). 64 | pub const OSFILE: ExitCode = 72; 65 | 66 | /// A (user specified) output file cannot be created. 67 | pub const CANTCREAT: ExitCode = 73; 68 | 69 | /// An error occurred while doing I/O on some file. 70 | pub const IOERR: ExitCode = 74; 71 | 72 | /// Temporary failure, indicating something that is not 73 | /// really an error. In sendmail, this means that a 74 | /// mailer (e.g.) could not create a connection, and 75 | /// the request should be reattempted later. 76 | pub const TEMPFAIL: ExitCode = 75; 77 | 78 | /// The remote system returned something that was 79 | /// "not possible" during a protocol exchange. 80 | pub const PROTOCOL: ExitCode = 76; 81 | 82 | /// You did not have sufficient permission to perform 83 | /// the operation. This is not intended for file system 84 | /// problems, which should use `NOINPUT` or `CANTCREAT`, 85 | /// but rather for higher level permissions. 86 | pub const NOPERM: ExitCode = 77; 87 | 88 | /// Something was found in an unconfigured or misconfigured state. 89 | pub const CONFIG: ExitCode = 78; 90 | 91 | /// Check if exit code given by `code` is successful 92 | /// 93 | /// # Example: 94 | /// ``` 95 | /// extern crate exitcode; 96 | /// 97 | /// assert!(exitcode::is_success(exitcode::OK)); 98 | /// assert!(!exitcode::is_success(exitcode::USAGE)); 99 | /// assert!(exitcode::is_success(0)); 100 | /// ``` 101 | pub fn is_success(code: ExitCode) -> bool { 102 | code == OK 103 | } 104 | 105 | /// Check if exit code given by `code` is an error 106 | /// 107 | /// # Example: 108 | /// ``` 109 | /// extern crate exitcode; 110 | /// 111 | /// assert!(exitcode::is_error(exitcode::USAGE)); 112 | /// assert!(!exitcode::is_error(exitcode::OK)); 113 | /// assert!(exitcode::is_error(1)); 114 | /// ``` 115 | pub fn is_error(code: ExitCode) -> bool { 116 | !is_success(code) 117 | } 118 | --------------------------------------------------------------------------------