dtolnay /thiserror

derive(Error) for struct and enum error types

★ 5,605⑂ 249👁 23⑃ 214● 234▤ 92
RustApache-2.0Created 2019-10-09
More from this author
Download: 2.0.212.0.21 ↓2.0.212026-09-23
+7
Daily
5,605
stars
249
forks
23
watchers
214
prs
234
issues
92
releases

README

derive(Error)
=============






This library provides a convenient derive macro for the standard library's
[std::error::Error] trait.

[std::error::Error]: https://doc.rust-lang.org/std/error/trait.Error.html

toml
[dependencies]
thiserror = "2"




 Example

rust
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,
}




 Details

- Thiserror deliberately does not appear in your public API. You get the same
  thing as if you had written an implementation of std::error::Error by hand,
  and switching from handwritten impls to thiserror or vice versa is not a
  breaking change.

- Errors may be enums, structs with named fields, tuple structs, or unit
  structs.

- A Display impl is generated for your error if you provide [error("...")]
  messages on the struct or each variant of your enum, as shown above in the
  example.

  The messages support a shorthand for interpolating fields from the error.

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

  These shorthands can be used together with any additional format args, which
  may be arbitrary expressions. For example:

  rust
  [derive(Error, Debug)]
  pub enum Error {
      [error("invalid rdo_lookahead_frames {0} (expected 

 Comparison to anyhow

Use thiserror if you care about designing your own dedicated error type(s) so
that the caller receives exactly the information that you choose in the event of
failure. This most often applies to library-like code. Use [Anyhow] if you don't
care what error type your functions return, you just want it to be easy. This is
common in application-like code.

[Anyhow]: https://github.com/dtolnay/anyhow



 License


Licensed under either of Apache License, Version
2.0 or MIT license at your option.





Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.

Top issues

Latest release

2.0.21 2.0.21 2026-09-23
- Fix parsing of generic unit variants in display expressions (459)

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON