narrate 0.4.2

narrate is a set of CLI app utilities for error handling and status reporting
Documentation 
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

//! If your application already uses anyhow, there are several ways to use this
//! library.
//!
//! 1. Replace every instance of any `anyhow` import with `narrate` (This could
//!    be tedious if you have a lot of contexts).
//!
//! 2. Only use `narrate::Error` in your outermost functions to use the help
//!    message feature.
//!
//! 3. Just use the `report` module to "pretty print" the anyhow errors.
//!
//! This is an example of the second method. It prints:
//!
//! ```console
//! error: error message
//!
//! help message
//! ```

use narrate::{report, Error, ErrorWrap, Result};

fn main() {
    if let Err(ref err) = outer_fn() {
        report::err(err);
    }
}

fn outer_fn() -> Result<()> {
    inner_fn()
        // here is where we convert from `anyhow::Error` to `narrate::Error`
        .map_err(Error::from_anyhow)
        // we can now safely add a help message
        .add_help("help message")
}

fn inner_fn() -> anyhow::Result<()> {
    anyhow::bail!("error message")
}