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

//! This crate provides error-related utilities.
//!
//! In particular, the [assert_err_box] macro is a minimalist way
//! to test the inner value of an `Err<Box<dyn Error>>` from a [Result]:
//!
//! ```
//! use dyn_error::*;
//! use std::fmt::Display;
//! use std::error::Error;
//!
//! #[derive(Debug, PartialEq, Eq)]
//! struct MyErr(pub u8);
//!
//! impl Display for MyErr {
//!     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
//!         write!(f, "Custom error: {}", self.0)
//!     }
//! }
//!
//! impl Error for MyErr {}
//!
//! let result: Result<String, Box<dyn Error>> = Err(Box::new(MyErr(90)));
//!
//! assert_err_box!(result, MyErr(90));
//! ```
//!
//! For more fine-grained control, the [check_err_box] function
//! performs the same test but returns a [Result] in lieu of calling [panic]:
//!
//! ```
//! use dyn_error::*;
//! use std::fmt::Display;
//! use std::error::Error;
//!
//! //
//! // Declaring a custom Error type
//! //
//! #[derive(Debug, PartialEq, Eq)]
//! struct MyErr(pub u8);
//!
//! impl Display for MyErr {
//!     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
//!         write!(f, "Custom error: {}", self.0)
//!     }
//! }
//!
//! impl Error for MyErr {}
//!
//! //
//! // Test scenarios
//! //
//! let result: Result<String, Box<dyn Error>> = Err(Box::new(MyErr(90)));
//! assert_eq!(
//!     check_err_box(result, MyErr(90)),
//!     Ok(())
//! );
//!
//! let result: Result<String, Box<dyn Error>> = Err(Box::new(MyErr(90)));
//! assert_eq!(
//!     check_err_box(result, MyErr(7)),
//!     Err(ErrBoxCheckFailure::NotEqual {
//!         expected: "Custom error: 7".to_string(),
//!         actual: "Custom error: 90".to_string()
//!     })
//! );
//! ```

mod err_box;

pub use err_box::*;