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
//! Assert macros for `Result` {`Ok`, `Err`}
//!
//! These macros help compare a `Result` that is either `Ok`, `Err`.
//!
//! The macros use these capabilities:
//!
//! * implements `.is_ok() -> boolean`
//!
//! * implements `.unwrap() -> comparable`
//!
//! * implements `.is_err() -> boolean`
//!
//! * implements `.unwrap_err() -> comparable`
//!
//! # Macros
//!
//! * [`assert_result_ok!(a)`](macro@crate::assert_result_ok) ≈ a.is_ok()
//!
//! * [`assert_result_ok_eq!(a, b)`](macro@crate::assert_result_ok_eq) ≈ a.is_ok() & b.is_ok() & a.unwrap() == b.unwrap()
//!
//! * [`assert_result_ok_ne!(a, b)`](macro@crate::assert_result_ok_ne) ≈ a.is_ok() & b.is_ok() & a.unwrap() != b.unwrap()
//!
//! * [`assert_result_err!(a)`](macro@crate::assert_result_err) ≈ a.is_err()
//!
//! # Example
//!
//! ```rust
//! use assertables::*;
//! # fn main() {
//! let a: Result<(), i8> = Result::Ok(());
//! assert_result_ok!(a);
//! # }
//! ```
// Assert for Result
pub mod assert_result_ok;
pub mod assert_result_ok_eq;
pub mod assert_result_ok_ne;
pub mod assert_result_err;