Rust错误处理库unwrap的使用，unwrap简化Option和Result类型的安全解包操作

该库提供了两个宏：unwrap!和unwrap_err!。前者可用于解包Result或Option类型（或任何实现了VerboseUnwrap的类型）的值，类似于调用unwrap()方法。后者可用于从Result中解包错误（或任何实现了VerboseUnwrapErr的类型），类似于调用unwrap_err()方法。

使用这些宏相比.unwrap()、.expect()、.unwrap_err()或.expect_err()方法的优势在于，当panic发生时，它们会打印出宏被调用的文件名、行号、列号和函数名。

示例

以下是示例代码：

let x: Result<(), u32> = Err(123);
let y = unwrap!(x);

当运行时会panic并显示如下信息：

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!   unwrap! called on Result::Err                                              !
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
example.rs:2,9 in example_module::example_function

Err(123)

unwrap!也可以带一个可选的自定义错误消息，作为格式化字符串和参数：

let x: Option<()> = None;
let y = unwrap!(x, "Oh no! {}", 123);

会打印：

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!   unwrap! called on Option::None                                             !
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
example.rs:2,9 in example_module::example_function
Oh no! 123

对于unwrap_err!：

let x: Result<u32, ()> = Ok(456);
let y = unwrap_err!(x);

会panic并显示：

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!   unwrap_err! called on Result::Ok                                           !
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
example.rs:2,9 in example_module::example_function

Ok(456)

完整示例代码

// 首先需要在Cargo.toml中添加依赖
// unwrap = "1.2.1"

#[macro_use]
extern crate unwrap;

fn main() {
    // 示例1: unwrap! 用于Result
    let result: Result<i32, &str> = Err("something went wrong");
    // let value = unwrap!(result);  // 这会panic并显示详细错误信息
    
    // 示例2: unwrap! 用于Option
    let option: Option<i32> = None;
    // let value = unwrap!(option, "Custom error message: {}", 123);  // 这会panic并显示自定义消息
    
    // 示例3: unwrap_err! 用于Result
    let result: Result<i32, &str> = Ok(42);
    // let err = unwrap_err!(result);  // 这会panic因为尝试解包Ok值
    
    // 正确用法示例
    let success_result: Result<i32, &str> = Ok(42);
    let success_value = unwrap!(success_result);  // 正确解包Ok值
    
    let error_result: Result<i32, &str> = Err("error message");
    let error_value = unwrap_err!(error_result);  // 正确解包Err值
    
    println!("Success value: {}", success_value);
    println!("Error value: {}", error_value);
}

使用方法

在Cargo.toml中添加以下依赖：

unwrap = "~1.1.0"

然后在代码中使用#[macro_use]导入：

#[macro_use]
extern crate unwrap;

实现原理

该库提供了一个可解包类型的trait：

trait VerboseUnwrap {
    type Wrapped;
    fn verbose_unwrap(self, message: Option<std::fmt::Arguments>,
                            module_path: &str,
                            file: &str,
                            line_number: u32,
                            column: u32) -> Self::Wrapped;
}

这个trait由Result和Option实现。unwrap!宏只是调用这个trait方法：

macro_rules! unwrap(
    ($e:expr) => (
        $crate::VerboseUnwrap::verbose_unwrap($e, None, module_path!(), file!(), line!(), column!())
    );
    ($e:expr, $($arg:tt)*) => (
        $crate::VerboseUnwrap::verbose_unwrap($e, Some(format_args!($($arg)*)), module_path!(), file!(), line!(), column!())
    );
);

同样，对于解包错误也有一个trait：

pub trait VerboseUnwrapErr {
    type Wrapped;
    fn verbose_unwrap_err self, message: Option<Arguments>,
                                module_path: &str,
                                file: &str,
                                line_number: u32,
                                column: u32) -> Self::Wrapped;
}

这个trait由Result实现，unwrap_err!宏调用这个trait方法：

macro_rules! unwrap_err(
    ($e:expr) => (
        $crate::VerboseUnwrapErr::verbose_unwrap_err($e, None, module_path!(), file!(), line!(), column!())
    );
    ($e:expr, $($arg:tt)*) => (
        $crate::VerboseUnwrapErr::verbose_unwrap_err($e, Some(format_args!($($arg)*)), module_path!(), file!(), line!(), column!())
    );
);