Rust Crate 使用：error-chain

Error-chain

Github

crates.io

前言

错误和异常傻傻分不清，这里统称为错误吧。Rust 错误分为两大类：可恢复和不可恢复的错误。

• 可恢复的错误，例如一个文件没有发现错误，这时合理的向用户报告的问题和重试操作。
• 不可恢复的错误总是就是不可恢复了,比如数组的越界访问。

大多语言，例如在c++对上述两类错误没有严格区分，可以使用相同的处理方式，返回值和抛异常，这两种方式在业界一直争论不休，分不清孰好孰坏。

然鹅 Rust 没有异常,它的类型Result用于处理可恢复错误； panic! 宏用于处理一个不可恢复的错误，将立即停止执行程序。

panic! 的处理方式在human-panic文章中提及如何处理。本文主要讲解Result类的错误处理。

介绍

error_chain目标是提供统一的，可靠的错误处理方式。

为什么使用它

• error-chain容易配置，以最小的代价处理错误。
• 对原生错误基本上不需要实现From接口就能使用 ?。
• 实现简单，不需要额外代码
• 正确管理错误的原因。

操作

原生操作

错误处理编程三步骤：

1. 定义自己的错误类型
2. 实现错误提示函数
3. 关联外部错误类型

首先，实现我们的自定义类型。

/// 第一步，自定义错误类型
#[derive(Debug)]
enum MyError {
    Single,
    Duple(String),
    Multi(u32, Vec),
    IO(io::Error),
}

/// 第二步，实现打印函数
impl fmt::Display for MyError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match &self {
            MyError::Single => write!(f, "Single Error"),
            MyError::Duple(ref err) => write!(f, "Dutple {} Error", err),
            MyError::Multi(ref len, ref data) => write!(f, "Multi len {} data {:?} Error", len, data),
            MyError::IO(ref e) => write!(f, "{}", e)
        }
    }
}

/// 错误通用化
impl std::error::Error for MyError {
    fn description(&self) -> &str {
        "MyError"
    }

    fn cause(&self) -> Option<&std::error::Error> {
        None
    }
}

实现上面两步，我们可以返回错误，并显示错误信息。当然，我们不能仅限于此，当我使用系统库或者第三方库时，通常会有其他错误类型，需要转换成MyError类型方便管理。

/// 第三步，实现其他错误类型转换
impl From for MyError {
    fn from(error: io::Error) -> Self {
        MyError::IO(error)
    }
}

完成上述三步，我们可以轻松处理错误了。 当我们读取不存在的文件返回了一个io错误，把它转换成MyError类型。

fn read() -> std::result::Result<(), MyError> {
    let _file = File::open("unknown_file.txt")?;
    std::result::Result::Ok(())
}

fn main() {
    match read() {
        std::result::Result::Ok(_) => println!("No Error"),
        std::result::Result::Err(e) => println!("{}", e),
    }
}

Error-chain操作

怎么让代码更加简洁呢？这时就需要用到error-chain了。它提供了error-chain!宏，帮我们实现了什么？引入官方例子：

// We'll put our errors in an `errors` module, and other modules in
// this crate will `use errors::*;` to get access to everything
// `error_chain!` creates.
mod errors {
    // Create the Error, ErrorKind, ResultExt, and Result types
    error_chain! { }
}

官方说帮我们实现了Error结构体，ErrorKind枚举，ResultExt结构体，Result别名。
现在用error-chain!重新实现先前的例子。

error_chain! {
    foreign_links {
        Io(::std::io::Error) #[doc = "Error during IO"];
    }
    errors {
        Single {
            description("MyError!")
            display("Single Error")
        }
        Duple(t: String) {
            description("MyError!")
            display("Dutple {} Error", t)
        }
        Multi(len: u32, data: Vec) {
            description("MyError!")
            display("Multi len {} data {:?} Error", len, data)
        }
    }
}

foreign_links类似实现了IO(io::Error)枚举类型，以及它的From接口。

尝试错误：

fn read_file() -> Result<()> {
    let _file = File::open("unknown_file.txt")?;
    std::result::Result::Ok(())
}

fn main() {
    match read_file() {
        std::result::Result::Ok(_) => println!("No Error"),
        std::result::Result::Err(e) => println!("{}", e),
    }
}

资料

announcing-error-chain-a-library-for-consistent-and-reliable-rust-error-handling
starting-with-error-chain