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

//! - Wraps errors in string and error contexts.
//! - Adds help text
//! - Reports to stderr
//! - Exits with error code

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

fn main() {
    let res = config_error()
        .wrap(CliError::Config)
        .add_help("See https://docs.example.rs/config for more info");

    if let Err(ref err) = res {
        report::err_full(err);
        std::process::exit(err.exit_code());
    }
}

/// Equivalent to:
/// ```no_run
/// serde_json::from_str(&json)
///     .wrap(|| format!("bad config file `{}`", path))
/// ```
fn config_error() -> Result<(), Error> {
    // simulate deserialization error
    let error = narrate::error_from!("missing key: 'port'");
    // wrap with config error
    let error = error.wrap("bad config file `/app/config.toml`");

    Err(error)
}