fatality

创建 致命性 和 非致命性 错误的生成方法。

生成的源代码大量使用了 thiserror::Error 派生属性，并将任何未知注释传递给该属性。

动机

对于大型单一代码库，随着子系统的增加，使用 thiserror 定义的嵌套错误变体进行 match 变得非常繁琐。使用 anyhow 或 eyre ——虽然它是一个应用——也带来了难以管理的痛苦，尤其是在中大型代码库中。

fatality 是解决这个问题的一种方法，通过使用注解扩展 thiserror::Error 来声明某些变体为 fatal，或将致命性提取转发到内部错误类型。

继续阅读！

用法

#[fatality] 默认提供了一个具有单个 fn is_fatal(&self) -> bool 方法的 trait Fatality。

带有 forward 的注解需要 内部 错误类型也实现 trait Fatality。

使用#[fatality(splitable)]进行注释，可以将类型拆分为两个子类型，一个Jfyi*和一个Fatal*，通过fn split(self) -> Result<Self::Jfyi, Self::Fatal>来实现。如果对splitable进行了注释。

derive宏实现了这些功能，并且可以根据thiserror注释进行调用延迟，具体是针对#[source]和#[transparent]注释在枚举类型及其成员上的实现。

/// Fatality only works with `enum` for now.
/// It will automatically add `#[derive(Debug, thiserror::Error)]`
/// annotations.
#[fatality]
enum OhMy {
    #[error("An apple a day")]
    Itsgonnabefine,

    /// Forwards the `is_fatal` to the `InnerError`, which has to implement `trait Fatality` as well.
    #[fatal(forward)]
    #[error("Dropped dead")]
    ReallyReallyBad(#[source] InnerError),

    /// Also works on `#[error(transparent)]
    #[fatal(forward)]
    #[error(transparent)]
    Translucent(InnerError),


    /// Will always return `is_fatal` as `true`,
    /// irrespective of `#[error(transparent)]` or
    /// `#[source]` annotations.
    #[fatal]
    #[error("So dead")]
    SoDead(#[source] InnerError),
}

#[fatality(splitable)]
enum Yikes {
    #[error("An apple a day")]
    Orange,

    #[fatal]
    #[error("So dead")]
    Dead,
}

fn foo() -> Result<[u8;32], Yikes> {
    Err(Yikes::Dead)
}

fn i_call_foo() -> Result<(), FatalYikes> {
    // availble via a convenience trait `Nested` that is implemented
    // for any `Result` whose error type implements `Split`.
    let x: Result<[u8;32], Jfyi> = foo().into_nested()?;
}

fn i_call_foo_too() -> Result<(), FatalYikes> {
    if let Err(jfyi_and_fatal_ones) = foo() {
        // bail if bad, otherwise just log it
        log::warn!("Jfyi: {:?}", jfyi_and_fatal_ones.split()?);
    }
}

路线图

• 可选地减少宏开销，用#[fatal($args)]#[error(..替换为#[fatal($args;..)]，并为thiserror生成正确的#[error]注释。
• 为finality添加一个可选参数：splitable确定这是一个需要处理的根错误，因此应将其拆分为两个枚举错误Fatal和Jfyi，并使用trait Split和fn split() -> Result<Jfyi, Fatal> {..}。
• 允许对struct进行注释，使其成为全部致命或信息性的。