在Rust中编写自定义Error

前言

之前我们聊过，Result 类型可以方便地用于错误传导，Result是模板类型，实例化后可以是各种类型，但 Rust 要求传导的 Result 中的 E 是相同类型的，或者能够自动转化为相同类型。比如，下面这段代码编译就会报错。所以我们需要编写自己的 Error 类型，以同时包含系统错误和具体业务错误。

use std::io;
use std::fs::{File};

fn read_fs() -> io::Result<()> {
    File::open("abc.txt")?;
    
    Ok(())
}

fn user_err() -> Result {
    Err(String::from("test faill"))
}

fn test() -> Result{
    read_fs()?;
    test()?;
}

pub fn main() {
    test();
}

系统Error

在 Result 中，E 表示一种错误，Rust 标准库已经定义一系列 Error，主要是 io Error。它的定义如下：

pub struct Error {
    repr: Repr,
}

我们可以通过它的关联函数 new，from，other，配合 ErrorKind 来生成一个io Error 用于Reuslt。

自定义 Error

我们要定义一个自己的 Error 类型，它既包含系统的 io Error，也包含业务 Error，定义如下

// 业务 Error 定义
enum WorkError {
  	WorkErrorFirst,
    WorkErrorSecond,
    WorkErrorThird,
}

// 复合 Error 定义
enum MyError {
  	IoErr(std::io::Error),
    WorkErr(WorkError)
}

使用 MyError

fn read_fs() -> Result<(), MyError> {
    let ret = File::open("abc.txt");
    
    if let Err(e) = ret {
        return Err(MyError::IoErr(e));
    } else {
        println!("ret = {ret:?}");
    }
    
    Ok(())
}

fn user_err() -> Result<(), MyError> {
    Err(MyError::WorkErr(WorkError::WorkErrorSecond))
}

fn test() -> Result<(), MyError>{
    read_fs()?;
    user_err()?;
    
    Ok(())
}

pub fn main() {
    let ret = test();
    
    match ret {
        Ok(_) => {
            println!("run test success");
        }
        Err(e) => {
            println!("run test fail");
        }
    }
}

在上述实现中，我们通过手动方式将 std::io::Error 转化为 MyError。也可以通过实现 From trait 来自动实现这种转化。

impl From for MyError {
    fn from(err: std::io::Error) -> Self {
        MyError::IoErr(err)
    }
}

// 这样，read_fs 函数就可以简化如下：
fn read_fs() -> Result<(), MyError> {
    File::open("abc.txt")?;
    Ok(())
}

现在还有一个问题，在 main 函数中，我们无法打印 e 信息。通过简单的为 WorkError 和 MyError 类型增加 #[derive(Debug)] 声明，就可以直接打印 e 信息。