从标准库的 std::error::Error 到 snafu 的错误处理演进

在Rust的错误处理生态系统中，从标准库的std::error::Error到anyhow、thiserror和snafu， 每个库都在用法和功能上进行了不同程度的改进和演变。 下面是对这些库的改进和设计的详细说明。

标准库的std::error::Error

特点

• 基础特性：定义了一个通用的错误trait，所有错误类型都可以实现这个trait。
• 手动实现：需要手动实现Display和Error trait，比较繁琐。

用法示例

use std::fmt;

#[derive(Debug)]
struct MyError {
    details: String,
}

impl fmt::Display for MyError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.details)
    }
}

impl std::error::Error for MyError {}

小结

要使用Rust标准库的Error trait实现自定义错误，那么需要做到以下两点：

• 实现std::fmt::Display trait，以便将错误信息显示给用户。
• 实现std::error::Error trait，以便将错误信息传递给调用者。

anyhow

该库提供了 anyhow::Error，一种基于特征对象(trait object)的错误类型， 用于在 Rust 应用程序中轻松地进行惯用错误处理。

改进

• 简化错误处理：提供了一个基于trait对象的通用错误类型anyhow::Error，简化了错误的传播和处理。
• 上下文信息：可以为错误添加上下文信息，帮助调试。
• 自动回溯：自动捕获和打印回溯信息（在Rust 1.65及以上）。

用法示例

use anyhow::{Context, Result};

fn read_file(path: &str) -> Result<String> {
    let content = std::fs::read_to_string(path)
        .with_context(|| format!("Failed to read file at path: {}", path))?;
    Ok(content)
}

小结

anyhow库通过提供anyhow::Error类型，简化了Rust中的错误处理。 它提供了一种简单的方式来处理和传播错误，同时支持添加上下文信息和自动回溯信息。

• 在anyhow中，经常使用的就是anyhow::Result与anyhow::anyhow宏
• 可以使用?符号进行错误传播，同时可以解包未出错的值

thiserror

这个库为标准库的 std::error::Error trait 提供了一个方便的派生宏。

改进

• 派生宏：通过派生宏简化了自定义错误类型的定义。
• 自动实现：自动实现Display和Error trait，减少了手动编码的负担。
• 与其他错误类型集成：可以轻松地将其他错误类型转换为自定义错误类型。

用法示例

use thiserror::Error;

#[derive(Error, Debug)]
pub enum MyError {
    #[error("IO error")]
    Io(#[from] std::io::Error),
    #[error("Parse error")]
    Parse(#[from] std::num::ParseIntError),
}

snafu

SNAFU 是一个可以轻松生成错误并向底层错误添加信息的库， 特别是当相同的底层错误类型可能发生在不同的上下文中时。

改进

• 错误类型生成：通过宏生成错误类型和相关的上下文信息。
• 上下文支持：更强大的上下文信息支持，提供了详细的错误信息。
• 源错误追踪：内置对源错误的追踪和显示。

用法示例

use snafu::{Snafu, ResultExt};

#[derive(Debug, Snafu)]
enum MyError {
    #[snafu(display("Failed to open file {}: {}", filename, source))]
    OpenFile { filename: String, source: std::io::Error },
    #[snafu(display("Failed to parse integer: {}", source))]
    ParseInt { source: std::num::ParseIntError },
}

fn read_file(path: &str) -> Result<String, MyError> {
    let content = std::fs::read_to_string(path).context(OpenFile { filename: path.to_string() })?;
    Ok(content)
}

总结

从Rust标准库的std::error::Error到anyhow、thiserror和snafu，经历了一系列的改进和设计：

• 从手动到自动：从标准库需要手动实现错误处理，到thiserror和snafu利用宏自动生成代码，减少了开发者的负担。
• 上下文信息：anyhow和snafu增强了对上下文信息的支持，使调试更加容易。
• 错误传播简化：anyhow通过统一的错误类型简化了错误传播，而snafu提供了强大的错误上下文支持。
• 回溯信息：anyhow自动捕获回溯信息，为调试提供了更多有用的信息。

这些改进和设计使得Rust的错误处理更加简洁、高效和易于维护。

参考

• Rust 标准库
• anyhow
• thiserror
• snafu