derive(Error)

该库提供了一个方便的 derive 宏，用于标准库的 std::error::Error trait。

[dependencies]
thiserror = "1.0"

编译器支持：需要 rustc 1.56+

示例

use thiserror::Error;

#[derive(Error, Debug)]
pub enum DataStoreError {
    #[error("data store disconnected")]
    Disconnect(#[from] io::Error),
    #[error("the data for key `{0}` is not available")]
    Redaction(String),
    #[error("invalid header (expected {expected:?}, found {found:?})")]
    InvalidHeader {
        expected: String,
        found: String,
    },
    #[error("unknown data store error")]
    Unknown,
}

详情

• Thiserror 故意不出现在你的公共API中。你将得到与手动编写 std::error::Error 相同的结果，从手动实现切换到 thiserror 或相反，不会造成破坏性更改。

• 错误可以是枚举、具有命名字段的元组结构体或单元结构体。

• 如果你在结构体或枚举的每个变体上提供了 #[error)] 消息，将为你生成一个 Display 实现，如示例中所示。

  这些消息支持从错误中插值字段的简写。

  • #[error("{var}")] ⟶ write!("{}", self.var)
  • #[error("{0}")] ⟶ write!("{}", self.0)
  • #[error("{var:?}")] ⟶ write!("{:?}", self.var)
  • #[error("{0:?}")] ⟶ write!("{:?}", self.0)

  这些简写可以与任何附加格式参数一起使用，这些参数可以是任意表达式。例如

  #[derive(Error, Debug)]
  pub enum Error {
      #[error("invalid rdo_lookahead_frames {0} (expected < {})", i32::MAX)]
      InvalidLookahead(u32),
  }
  

  如果额外的表达式参数需要引用结构体或枚举的字段，则将命名字段引用为.var，将元组字段引用为.0。

  #[derive(Error, Debug)]
  pub enum Error {
      #[error("first letter must be lowercase but was {:?}", first_char(.0))]
      WrongCase(String),
      #[error("invalid index {idx}, expected at least {} and at most {}", .limits.lo, .limits.hi)]
      OutOfBounds { idx: usize, limits: Limits },
  }
  

• 为包含#[from]属性的每个变体生成一个From实现。

  注意，变体必须不包含除源错误和可能的后追踪之外的其他字段。如果有后追踪字段，后追踪将从From实现中捕获。

  #[derive(Error, Debug)]
  pub enum MyError {
      Io {
          #[from]
          source: io::Error,
          backtrace: Backtrace,
      },
  }
  

• 实现了Error trait的source()方法，以返回具有#[source]属性或名为source的任何字段的任何字段。这是为了识别导致您的错误的底层错误。

  #[from]属性始终意味着相同的字段是#[source]，因此您不需要同时指定这两个属性。

  实现 std::error::Error 或对 dyn std::error::Error 的解引用的任何错误类型都将作为源工作。

  #[derive(Error, Debug)]
  pub struct MyError {
      msg: String,
      #[source]  // optional if field name is `source`
      source: anyhow::Error,
  }
  

• 错误特质的 provide() 方法实现为提供任何名为 Backtrace 的字段，如果有，作为 std::backtrace::Backtrace。

  use std::backtrace::Backtrace;
  
  #[derive(Error, Debug)]
  pub struct MyError {
      msg: String,
      backtrace: Backtrace,  // automatically detected
  }
  

• 如果一个字段既是源（命名为 source，或具有 #[source] 或 #[from] 属性）并且被标记为 #[backtrace]，那么错误特质的 provide() 方法会被转发到源的 provide，以便错误的两层都共享相同的回溯。

  #[derive(Error, Debug)]
  pub enum MyError {
      Io {
          #[backtrace]
          source: io::Error,
      },
  }
  

• 错误可以使用 error(transparent) 来直接将源和显示方法转发到底层的错误，而无需添加额外的消息。这对于需要“其他所有情况”变体的枚举来说是合适的。

  #[derive(Error, Debug)]
  pub enum MyError {
      ...
  
      #[error(transparent)]
      Other(#[from] anyhow::Error),  // source and Display delegate to anyhow::Error
  }
  

  另一个用例是在不破坏公共API的情况下，将错误表示的实现细节隐藏在一个不透明的错误类型后面，以便表示能够进化。

  // PublicError is public, but opaque and easy to keep compatible.
  #[derive(Error, Debug)]
  #[error(transparent)]
  pub struct PublicError(#[from] ErrorRepr);
  
  impl PublicError {
      // Accessors for anything we do want to expose publicly.
  }
  
  // Private and free to change across minor version of the crate.
  #[derive(Error, Debug)]
  enum ErrorRepr {
      ...
  }
  

• 有关在应用程序代码中使用方便的单个错误类型的库，请参阅 anyhow。

与anyhow的比较

如果你关心设计自己的专用错误类型，以便在失败时调用者接收到的信息正好是你选择的，请使用thiserror。这通常适用于类似库的代码。如果你不关心函数返回什么错误类型，只是想让它变得简单，请使用 Anyhow。这在类似应用程序的代码中很常见。

许可证