https://github.com/fleshgrinder/rust-exit-code

Commonly used exit codes for usage in applications.
https://github.com/fleshgrinder/rust-exit-code

cli exit-codes rust rust-library sysexits

Last synced: 24 days ago
JSON representation

Commonly used exit codes for usage in applications.

• Host: GitHub
• URL: https://github.com/fleshgrinder/rust-exit-code
• Owner: Fleshgrinder
• License: other
• Created: 2017-06-04T08:50:34.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-06-16T23:44:48.000Z (over 2 years ago)
• Last Synced: 2024-10-13T11:14:58.457Z (25 days ago)
• Topics: cli, exit-codes, rust, rust-library, sysexits
• Language: Rust
• Homepage: https://crates.io/crates/exit-code
• Size: 8.79 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rust Exit Codes

Commonly used exit codes for usage in applications.

Using appropriate exit codes greatly helps users of applications to assert them

in their own scripts and take appropriate actions based on the returned code.

Simply using the catchall exit code _1_ all the time does not help others in

any way. Unless there is only a single source of error in the complete

application, which is very unlikely.

## Installation

Add the following to your `Cargo.toml` file:

```toml

[dependencies]

exit-code = "1.0.0"

```

## Usage

```rust

extern crate exit_code;

fn main() {

    use std::process::exit;

    use exit_code::SUCCESS;

    println!("Hello, World!");

    exit(SUCCESS);

}

```

This crate provides two additional functions that allow validation of exit

codes:

- `is_reserved(exit_code) -> bool` can be used to check if a given exit code

  has a reserved meaning in a shell, refer to the API documentation for the

  meaning of the reserved exit codes.

- `is_valid(exit_code) -> bool` can be used to check if a given exit code is

  within the range `[0..256]` (anything below or beyond silently overflows).

## References

- Advanced Bash-Scripting Guide: [Appendix E. Exit Codes With Special Meanings](http://tldp.org/LDP/abs/html/exitcodes.html)

- FreeBSD Man Pages: [`man sysexits(3)`](https://www.freebsd.org/cgi/man.cgi?query=sysexits)