#path #propagation #error #catch #backtrace #helper #err

erreport

A Result 辅助库,用于捕获 Rust 中所有 Err 传播路径

4 个版本 (2 个重大更改)

0.3.0 2024 年 5 月 9 日
0.2.1 2023 年 8 月 3 日
0.1.1 2023 年 7 月 18 日
0.1.0 2023 年 7 月 18 日

#510Rust 模式

MIT 许可证

7KB
87

erreport

A Result 辅助库,用于捕获所有 Err 传播路径

为什么?

当一个 Err 被传播时,我们需要一个方法来捕获所有传播路径。

因此,我们可以在 release 模式下通过 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

相较于 Backtrace 的优势

  • 不需要 RUST_BACKTRACE=1
  • 不需要 debug=1
  • 记录了包及其版本。

如何使用

// 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::gen_trait_to_report!(); 

fn test() -> Result<(), erreport::Report> {
    any_result_impl_std_error_Error.to_report()?;
    any_result_impl_std_error_Error.to_report()?;
    Ok(())
}

如何访问实际的错误?

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

无运行时依赖