Crate erreport

erreport

A Result helper to catch all the Err propagation path

Why?

When an Err propagated, we need a method catch all the propagation path.

So we can get this report in release mode with debug=0:

{package0@version0} src/lib.rs:56 -> src/xx.rs:23 -> {package1@version1} src/lib.rs:42 -> src/yy.rs:632 -> src/zz.rs:56  
  -> {package2@version2} src/lib.rs:251 -> InvalidXXX

Pros over Backtrace

• No RUST_BACKTRACE=1 needed.
• No debug=1 needed.
• Packages and their versions are recorded.

How to use

// This will generate a trait called `pub(crate) trait ToReport<T>` to help to convert any `Result<T, E: std::error::Error>` to `Report`.
// You just need to call once for each crate.
erreport::prepare!(); 
 
fn test() -> Report<()> {
    any_result_impl_std_error_Error.report()?;
    any_result_impl_std_error_Error.report()?;
    Ok(())
}

How to access the actual Error?

fn main() {
    if let Err(err) = test() {
        // This method will bypass all the `Report` wrappers and get the first actual `Error` value.
        err.source() 
    }
}

Macros

prepare

This will generate:

Structs

Report

You can use .source() to get the first real source in Report