+7
日增长
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
#98Display cause chain when alternate format is used8 comments · 2020-09-19#135Improve #[from] documentation example.4 comments · 2021-05-26#390Support From generation for Backtrace in stable rust3 comments · 2024-11-22#142Support for tracing with `Std::panic::Location` (Feature Request)3 comments · 2021-07-15#8Implement `sources` on the type that derives Error3 comments · 2019-10-10#435[Feature request] Enabling support for transitive "#[from]' handling2 comments · 2025-10-02#424Attribute like `from` for `Box`ing large error variants2 comments · 2025-07-25#412Common prefix2 comments · 2025-02-01
Latest release
2.0.21 2.0.21 2026-09-23- Fix parsing of generic unit variants in display expressions (459)