failure - 一个新的错误管理故事

failure旨在使管理 Rust 中的错误变得更加容易。它旨在用基于过去几年经验（包括从 quick-error 和 error-chain 的经验中学习到的经验）的新系统来替换基于 std::error::Error 的错误管理。

failure提供两个核心组件

• Fail：用于自定义错误类型的新特质。
• Error：任何实现 Fail 的类型都可以转换成的结构体。

演变

failure 目前作为一个库在演变。首先，在 Rust 本身正在进行修复错误特质的工作，其次，failure 向 1.0 的原始计划可能不会以当前的形式发生。

因此，failure 向 1.0 的原始 master 分支已被删除，现在 master 代表 0.1 的未来迭代步骤，直到在 stdlib 中明确发生什么。

原始 1.0 分支可以在 evolution/1.0 中找到。

示例

extern crate serde;
extern crate toml;

#[macro_use] extern crate failure;
#[macro_use] extern crate serde_derive;

use std::collections::HashMap;
use std::path::PathBuf;
use std::str::FromStr;

use failure::Error;

// This is a new error type that you've created. It represents the ways a
// toolchain could be invalid.
//
// The custom derive for Fail derives an impl of both Fail and Display.
// We don't do any other magic like creating new types.
#[derive(Debug, Fail)]
enum ToolchainError {
    #[fail(display = "invalid toolchain name: {}", name)]
    InvalidToolchainName {
        name: String,
    },
    #[fail(display = "unknown toolchain version: {}", version)]
    UnknownToolchainVersion {
        version: String,
    }
}

pub struct ToolchainId {
    // ... etc
}

impl FromStr for ToolchainId {
    type Err = ToolchainError;

    fn from_str(s: &str) -> Result<ToolchainId, ToolchainError> {
        // ... etc
    }
}

pub type Toolchains = HashMap<ToolchainId, PathBuf>;

// This opens a toml file containing associations between ToolchainIds and
// Paths (the roots of those toolchains).
//
// This could encounter an io Error, a toml parsing error, or a ToolchainError,
// all of them will be thrown into the special Error type
pub fn read_toolchains(path: PathBuf) -> Result<Toolchains, Error>
{
    use std::fs::File;
    use std::io::Read;

    let mut string = String::new();
    File::open(path)?.read_to_string(&mut string)?;

    let toml: HashMap<String, PathBuf> = toml::from_str(&string)?;

    let toolchains = toml.iter().map(|(key, path)| {
        let toolchain_id = key.parse()?;
        Ok((toolchain_id, path))
    }).collect::<Result<Toolchains, ToolchainError>>()?;

    Ok(toolchains)
}

要求

failure 和 failure_derive 都旨在在 Rust 1.18.0 之后的所有稳定版本以及最新的 beta 和最新的 nightly 版本上编译。如果任一 crate 在 1.18.0 之后任何版本上编译失败，请提交一个问题。

failure 与 无 std 兼容，尽管它的一些方面（主要是 Error 类型）在无 std 模式下将不可用。

许可证

failure 根据 MIT 许可证或 Apache 许可证 2.0 的条款进行许可，由您选择。

行为准则

failure crate 的贡献组织在贡献者协约的条款下，failure 的维护者 @withoutboats 承诺将介入维护该行为准则。