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
//! ## Features
//!
//! - `i32` newtype for exit codes
//! - Can represent any valid exit code
//! - Type safe, operations are restricted to what is valid for exit codes
//! - Includes common exit codes and signal exit codes
//! - Integrate with `main`, `std::process`, and `std::io::Error`
//! - Supports exiting silently (error message reported through another means)
//!
//! ## Install
//!
//! Add to your `Cargo.toml`:
//!
//! ```console
//! $ cargo add proc-exit
//! ```
//!
//! # Example
//!
//! ```
//! use proc_exit::prelude::*;
//!
//! fn main() {
//! // Simple but Macro-less `main`
//! // - Fast compiles
//! // - Composable with other features
//! let result = run();
//! proc_exit::exit(result);
//! }
//!
//! fn run() -> proc_exit::ExitResult {
//! // Integrates directly with `std::io::Error`, returning the right exit code.
//! let exit_status = std::process::Command::new("true")
//! .status().with_code(proc_exit::Code::FAILURE)?;
//! // Can pass `Command` exit codes right up, when appropriate
//! proc_exit::Code::from_status(exit_status).ok()?;
//!
//! proc_exit::Code::SUCCESS.ok()
//! }
//! ```
//!
//! ## Relevant crates
//!
//! Other crates that might be useful in testing command line programs.
//! - [duct][duct] for orchestrating multiple processes.
//! - or [commandspec][commandspec] for easier writing of commands
//! - [rexpect][rexpect] for controlling interactive programs.
//! - [`assert_cmd`][assert_cmd] can be reused to simplify controlling CLIs
//!
//! [duct]: https://crates.io/crates/duct
//! [rexpect]: https://crates.io/crates/rexpect
//! [assert_cmd]: https://crates.io/crates/assert_cmd
//! [commandspec]: https://crates.io/crates/commandspec
//!
//! ## Related crates
//!
//! Some crates that fill a similar role include:
//! - [sysexit][sysexit]
//! - Uses an enum, making certain states unrepresentable
//! - Includes signals
//! - Integrates with `std::process` and `std::io::Error`
//! - Doesn't integrate with `main`
//! - [exit-code][exit-code]
//! - `i32` constants and helper methods
//! - Doesn't include signals
//! - Doesn't integrate with `main`, `std::process`, or `std::io::Error`
//! - [exitcode][exitcode]
//! - `i32` constants and helper methods
//! - Doesn't include signals
//! - Doesn't integrate with `main`, `std::process`, or `std::io::Error`
//! - [exitfailure][exitfailure]
//! - Allows `Display`able errors to be used with [`?` in `main()`](https://github.com/rust-lang/rust/issues/43301)
//!
//! [sysexit]: https://crates.io/crates/sysexit
//! [exit-code]: https://crates.io/crates/exit-code
//! [exitcode]: https://crates.io/crates/exitcode
//! [exitfailure]: https://crates.io/crates/exitfailure
mod code;
mod exit;
/// Easy access to traits
pub mod prelude {
pub use super::WithCodeResultExt as _;
pub use crate::sysexits::ToSysexitsResultExt as _;
}
pub mod bash;
pub mod sysexits;
pub use code::Code;
pub use exit::WithCodeResultExt;
pub use exit::{exit, report};
pub use exit::{Exit, ExitResult};