From<docs>
This library provides a convenient derive macro for the standard library's
[core::fmt::Display] trait.
toml
[dependencies]
displaydoc = "0.1.4"
Compiler support: requires rustc 1.31+
```rust use displaydoc::Display; use thiserror::Error;
pub enum DataStoreError {
/// data store disconnected
Disconnect(#[source] io::Error),
/// the data for key {0} is not available
Redaction(String),
/// invalid header (expected {expected:?}, found {found:?})
InvalidHeader {
expected: String,
found: String,
},
/// unknown data store error
Unknown,
}
```
A Display impl is generated for your type if you provide doc comment
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.
/// {var} ⟶ write!("{}", self.var)/// {0} ⟶ write!("{}", self.0)/// {var:?} ⟶ write!("{:?}", self.var)/// {0:?} ⟶ write!("{:?}", self.0)no_std compatible?
core::fmt::Display trait not the std::fmt::Display trait so it should work in std and no_std environments.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.