pub trait Error: Debug + Display {
// Provided methods
fn source(&self) -> Option<&(dyn Error + 'static)> { ... }
fn description(&self) -> &str { ... }
fn cause(&self) -> Option<&dyn Error> { ... }
fn provide<'a>(&'a self, request: &mut Request<'a>) { ... }
}Expand description
Error is a trait representing the basic expectations for error values,
i.e., values of type E in Result<T, E>.
Errors must describe themselves through the Display and Debug
traits. Error messages are typically concise lowercase sentences without
trailing punctuation:
let err = "NaN".parse::<u32>().unwrap_err();
assert_eq!(err.to_string(), "invalid digit found in string");§Error source
Errors may provide cause information. Error::source() is generally
used when errors cross “abstraction boundaries”. If one module must report
an error that is caused by an error from a lower-level module, it can allow
accessing that error via Error::source(). This makes it possible for the
high-level module to provide its own errors while also revealing some of the
implementation for debugging.
In error types that wrap an underlying error, the underlying error
should be either returned by the outer error’s Error::source(), or rendered
by the outer error’s Display implementation, but not both.
§Example
Implementing the Error trait only requires that Debug and Display are implemented too.
use std::error::Error;
use std::fmt;
use std::path::PathBuf;
#[derive(Debug)]
struct ReadConfigError {
path: PathBuf
}
impl fmt::Display for ReadConfigError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let path = self.path.display();
write!(f, "unable to read configuration at {path}")
}
}
impl Error for ReadConfigError {}Provided Methods§
1.30.0 · Sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any.
§Examples
use std::error::Error;
use std::fmt;
#[derive(Debug)]
struct SuperError {
source: SuperErrorSideKick,
}
impl fmt::Display for SuperError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "SuperError is here!")
}
}
impl Error for SuperError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
Some(&self.source)
}
}
#[derive(Debug)]
struct SuperErrorSideKick;
impl fmt::Display for SuperErrorSideKick {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "SuperErrorSideKick is here!")
}
}
impl Error for SuperErrorSideKick {}
fn get_super_error() -> Result<(), SuperError> {
Err(SuperError { source: SuperErrorSideKick })
}
fn main() {
match get_super_error() {
Err(e) => {
println!("Error: {e}");
println!("Caused by: {}", e.source().unwrap());
}
_ => println!("No error"),
}
}1.0.0 · Sourcefn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
fn description(&self) -> &str
if let Err(e) = "xc".parse::<u32>() {
// Print `e` itself, no need for description().
eprintln!("Error: {e}");
}fn cause(&self) -> Option<&dyn Error>
Sourcefn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
fn provide<'a>(&'a self, request: &mut Request<'a>)
error_generic_member_access)Provides type-based access to context intended for error reports.
Used in conjunction with Request::provide_value and Request::provide_ref to extract
references to member variables from dyn Error trait objects.
§Example
#![feature(error_generic_member_access)]
use core::fmt;
use core::error::{request_ref, Request};
#[derive(Debug)]
enum MyLittleTeaPot {
Empty,
}
#[derive(Debug)]
struct MyBacktrace {
// ...
}
impl MyBacktrace {
fn new() -> MyBacktrace {
// ...
}
}
#[derive(Debug)]
struct Error {
backtrace: MyBacktrace,
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Example Error")
}
}
impl std::error::Error for Error {
fn provide<'a>(&'a self, request: &mut Request<'a>) {
request
.provide_ref::<MyBacktrace>(&self.backtrace);
}
}
fn main() {
let backtrace = MyBacktrace::new();
let error = Error { backtrace };
let dyn_error = &error as &dyn std::error::Error;
let backtrace_ref = request_ref::<MyBacktrace>(dyn_error).unwrap();
assert!(core::ptr::eq(&error.backtrace, backtrace_ref));
assert!(request_ref::<MyLittleTeaPot>(dyn_error).is_none());
}Implementations§
Source§impl dyn Error
impl dyn Error
1.3.0 · Sourcepub fn is<T>(&self) -> boolwhere
T: Error + 'static,
pub fn is<T>(&self) -> boolwhere
T: Error + 'static,
Returns true if the inner type is the same as T.
1.3.0 · Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: Error + 'static,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: Error + 'static,
Returns some reference to the inner value if it is of type T, or
None if it isn’t.
1.3.0 · Sourcepub fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: Error + 'static,
pub fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: Error + 'static,
Returns some mutable reference to the inner value if it is of type T, or
None if it isn’t.
Source§impl dyn Error + Send
impl dyn Error + Send
1.3.0 · Sourcepub fn is<T>(&self) -> boolwhere
T: Error + 'static,
pub fn is<T>(&self) -> boolwhere
T: Error + 'static,
Forwards to the method defined on the type dyn Error.
1.3.0 · Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: Error + 'static,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: Error + 'static,
Forwards to the method defined on the type dyn Error.
1.3.0 · Sourcepub fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: Error + 'static,
pub fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: Error + 'static,
Forwards to the method defined on the type dyn Error.
Source§impl dyn Error + Sync + Send
impl dyn Error + Sync + Send
1.3.0 · Sourcepub fn is<T>(&self) -> boolwhere
T: Error + 'static,
pub fn is<T>(&self) -> boolwhere
T: Error + 'static,
Forwards to the method defined on the type dyn Error.
1.3.0 · Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: Error + 'static,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: Error + 'static,
Forwards to the method defined on the type dyn Error.
1.3.0 · Sourcepub fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: Error + 'static,
pub fn downcast_mut<T>(&mut self) -> Option<&mut T>where
T: Error + 'static,
Forwards to the method defined on the type dyn Error.
Source§impl dyn Error
impl dyn Error
Sourcepub fn sources(&self) -> Source<'_>
🔬This is a nightly-only experimental API. (error_iter)
pub fn sources(&self) -> Source<'_>
error_iter)Returns an iterator starting with the current error and continuing with
recursively calling Error::source.
If you want to omit the current error and only use its sources,
use skip(1).
§Examples
#![feature(error_iter)]
use std::error::Error;
use std::fmt;
#[derive(Debug)]
struct A;
#[derive(Debug)]
struct B(Option<Box<dyn Error + 'static>>);
impl fmt::Display for A {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "A")
}
}
impl fmt::Display for B {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "B")
}
}
impl Error for A {}
impl Error for B {
fn source(&self) -> Option<&(dyn Error + 'static)> {
self.0.as_ref().map(|e| e.as_ref())
}
}
let b = B(Some(Box::new(A)));
// let err : Box<Error> = b.into(); // or
let err = &b as &dyn Error;
let mut iter = err.sources();
assert_eq!("B".to_string(), iter.next().unwrap().to_string());
assert_eq!("A".to_string(), iter.next().unwrap().to_string());
assert!(iter.next().is_none());
assert!(iter.next().is_none());Trait Implementations§
1.6.0 · Source§impl<'a> From<&str> for Box<dyn Error + 'a>
Available on non-no_global_oom_handling only.
impl<'a> From<&str> for Box<dyn Error + 'a>
no_global_oom_handling only.1.0.0 · Source§impl<'a> From<&str> for Box<dyn Error + Sync + Send + 'a>
Available on non-no_global_oom_handling only.
impl<'a> From<&str> for Box<dyn Error + Sync + Send + 'a>
no_global_oom_handling only.1.22.0 · Source§impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + 'a>
Available on non-no_global_oom_handling only.
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + 'a>
no_global_oom_handling only.1.22.0 · Source§impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Sync + Send + 'a>
Available on non-no_global_oom_handling only.
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Sync + Send + 'a>
no_global_oom_handling only.Source§fn from(err: Cow<'b, str>) -> Box<dyn Error + Sync + Send + 'a>
fn from(err: Cow<'b, str>) -> Box<dyn Error + Sync + Send + 'a>
Converts a Cow into a box of dyn Error + Send + Sync.
§Examples
use std::error::Error;
use std::borrow::Cow;
let a_cow_str_error = Cow::from("a str error");
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(a_cow_str_error);
assert!(
size_of::<Box<dyn Error + Send + Sync>>() == size_of_val(&a_boxed_error))1.0.0 · Source§impl<'a, E> From<E> for Box<dyn Error + 'a>where
E: Error + 'a,
Available on non-no_global_oom_handling only.
impl<'a, E> From<E> for Box<dyn Error + 'a>where
E: Error + 'a,
no_global_oom_handling only.Source§fn from(err: E) -> Box<dyn Error + 'a>
fn from(err: E) -> Box<dyn Error + 'a>
Converts a type of Error into a box of dyn Error.
§Examples
use std::error::Error;
use std::fmt;
#[derive(Debug)]
struct AnError;
impl fmt::Display for AnError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "An error")
}
}
impl Error for AnError {}
let an_error = AnError;
assert!(0 == size_of_val(&an_error));
let a_boxed_error = Box::<dyn Error>::from(an_error);
assert!(size_of::<Box<dyn Error>>() == size_of_val(&a_boxed_error))1.0.0 · Source§impl<'a, E> From<E> for Box<dyn Error + Sync + Send + 'a>
Available on non-no_global_oom_handling only.
impl<'a, E> From<E> for Box<dyn Error + Sync + Send + 'a>
no_global_oom_handling only.Source§fn from(err: E) -> Box<dyn Error + Sync + Send + 'a>
fn from(err: E) -> Box<dyn Error + Sync + Send + 'a>
Converts a type of Error + Send + Sync into a box of
dyn Error + Send + Sync.
§Examples
use std::error::Error;
use std::fmt;
#[derive(Debug)]
struct AnError;
impl fmt::Display for AnError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "An error")
}
}
impl Error for AnError {}
unsafe impl Send for AnError {}
unsafe impl Sync for AnError {}
let an_error = AnError;
assert!(0 == size_of_val(&an_error));
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(an_error);
assert!(
size_of::<Box<dyn Error + Send + Sync>>() == size_of_val(&a_boxed_error))1.6.0 · Source§impl<'a> From<String> for Box<dyn Error + 'a>
Available on non-no_global_oom_handling only.
impl<'a> From<String> for Box<dyn Error + 'a>
no_global_oom_handling only.1.0.0 · Source§impl<'a> From<String> for Box<dyn Error + Sync + Send + 'a>
Available on non-no_global_oom_handling only.
impl<'a> From<String> for Box<dyn Error + Sync + Send + 'a>
no_global_oom_handling only.Implementors§
impl !Error for &str
impl Error for Infallible
impl Error for FromBytesWithNulError
impl Error for core::slice::GetDisjointMutError
impl Error for VarError
impl Error for std::fs::TryLockError
impl Error for RecvTimeoutError
impl Error for std::sync::mpsc::TryRecvError
impl Error for DecodeError
std only.impl Error for base64ct::errors::Error
std only.impl Error for bs58::alphabet::Error
std only.impl Error for bs58::decode::Error
std only.impl Error for bs58::encode::Error
std only.impl Error for byte_slice_cast::Error
std only.impl Error for ed25519_zebra::error::Error
std only.impl Error for hex::error::FromHexError
std only.impl Error for httparse::Error
std only.impl Error for indexmap::GetDisjointMutError
std only.impl Error for libsecp256k1_core::error::Error
std only.impl Error for parity_bip39::Error
std only.impl Error for parity_wasm::elements::Error
std only.impl Error for password_hash::errors::Error
std only.impl Error for InvalidValue
std only.impl Error for pkcs8::error::Error
std only.impl Error for CommittedCandidateReceiptError
impl Error for prometheus::errors::Error
impl Error for BernoulliError
std only.impl Error for WeightedError
std only.impl Error for StartError
std only.impl Error for regex_syntax::error::Error
std only.impl Error for regex_syntax::error::Error
impl Error for regex::error::Error
std only.impl Error for rustc_hex::FromHexError
std only.impl Error for sec1::error::Error
std only.impl Error for secp256k1::Error
std only.impl Error for ApiError
impl Error for sp_core::address_uri::Error
impl Error for DeriveError
impl Error for PublicError
impl Error for SecretStringError
impl Error for sp_inherents::Error
impl Error for sp_keystore::Error
std only.impl Error for TransactionValidityError
std only.impl Error for ExecutionError
impl Error for InherentError
impl Error for sp_version::embed::Error
impl Error for spki::error::Error
std only.impl Error for substrate_prometheus_endpoint::Error
impl Error for time::error::Error
std only.impl Error for Format
std only.impl Error for InvalidFormatDescription
std only.impl Error for AnyDelimiterCodecError
impl Error for LinesCodecError
impl Error for TryAcquireError
impl Error for tokio::sync::broadcast::error::RecvError
impl Error for tokio::sync::broadcast::error::TryRecvError
impl Error for tokio::sync::mpsc::error::TryRecvError
impl Error for tokio::sync::oneshot::error::TryRecvError
impl Error for FromDecStrErr
std only.impl Error for !
impl Error for xcm_emulator::fmt::Error
impl Error for UnorderedKeyError
impl Error for alloc::collections::TryReserveError
impl Error for FromVecWithNulError
impl Error for IntoStringError
impl Error for NulError
impl Error for FromUtf8Error
impl Error for FromUtf16Error
impl Error for LayoutError
impl Error for AllocError
impl Error for TryFromSliceError
impl Error for BorrowError
impl Error for BorrowMutError
impl Error for CharTryFromError
impl Error for ParseCharError
impl Error for DecodeUtf16Error
impl Error for TryFromCharError
impl Error for FromBytesUntilNulError
impl Error for AddrParseError
impl Error for ParseFloatError
impl Error for core::num::error::ParseIntError
impl Error for core::num::error::TryFromIntError
impl Error for ParseBoolError
impl Error for Utf8Error
impl Error for TryFromFloatSecsError
impl Error for JoinPathsError
impl Error for WriterPanicked
impl Error for std::io::error::Error
impl Error for NormalizeError
impl Error for StripPrefixError
impl Error for ExitStatusError
impl Error for std::sync::mpsc::RecvError
impl Error for AccessError
impl Error for SystemTimeError
impl Error for aho_corasick::util::error::BuildError
std only.impl Error for aho_corasick::util::error::MatchError
std only.impl Error for aho_corasick::util::primitives::PatternIDError
std only.impl Error for aho_corasick::util::primitives::StateIDError
std only.impl Error for InvalidEncodingError
std only.impl Error for InvalidLengthError
std only.impl Error for TryGetError
std only.impl Error for InvalidLength
std only.impl Error for der::error::Error
std only.impl Error for deranged::ParseIntError
std only.impl Error for deranged::TryFromIntError
std only.impl Error for digest::errors::InvalidOutputSize
std only.impl Error for MacError
std only.impl Error for InvalidBufferSize
std only.impl Error for digest::InvalidOutputSize
std only.impl Error for elliptic_curve::error::Error
std only.impl Error for futures_channel::mpsc::SendError
impl Error for futures_channel::mpsc::TryRecvError
impl Error for Canceled
std only.impl Error for EnterError
impl Error for SpawnError
std only.impl Error for Aborted
std only.impl Error for getrandom::error::Error
impl Error for h2::error::Error
impl Error for LengthLimitError
impl Error for http::error::Error
impl Error for MaxSizeReached
impl Error for InvalidHeaderName
impl Error for InvalidHeaderValue
impl Error for ToStrError
impl Error for InvalidMethod
impl Error for InvalidStatusCode
impl Error for InvalidUri
impl Error for InvalidUriParts
impl Error for httpdate::Error
impl Error for hyper::error::Error
impl Error for indexmap::TryReserveError
std only.impl Error for jam_codec::error::Error
std only.impl Error for log::ParseLevelError
std only.impl Error for SetLoggerError
std only.impl Error for num_format::error::Error
impl Error for parity_scale_codec::error::Error
std only.impl Error for ReadError
impl Error for rand_core::error::Error
std only.impl Error for regex_automata::dfa::onepass::BuildError
std only.impl Error for regex_automata::error::Error
impl Error for regex_automata::hybrid::error::BuildError
std only.impl Error for CacheError
std only.impl Error for regex_automata::meta::error::BuildError
std only.impl Error for regex_automata::nfa::thompson::error::BuildError
std only.impl Error for GroupInfoError
std only.impl Error for UnicodeWordBoundaryError
std only.impl Error for regex_automata::util::primitives::PatternIDError
std only.impl Error for SmallIndexError
std only.impl Error for regex_automata::util::primitives::StateIDError
std only.impl Error for regex_automata::util::search::MatchError
std only.impl Error for PatternSetInsertError
std only.impl Error for DeserializeError
std only.impl Error for SerializeError
std only.impl Error for regex_syntax::ast::Error
std only.impl Error for regex_syntax::ast::Error
impl Error for regex_syntax::hir::Error
std only.impl Error for regex_syntax::hir::Error
impl Error for regex_syntax::unicode::CaseFoldError
std only.impl Error for regex_syntax::unicode::CaseFoldError
impl Error for regex_syntax::unicode::UnicodeWordError
std only.impl Error for regex_syntax::unicode::UnicodeWordError
impl Error for InvalidParityValue
std only.impl Error for OutOfRangeError
std only.impl Error for serde_core::de::value::Error
std only.impl Error for serde_json::error::Error
impl Error for signature::error::Error
std only.impl Error for ss58_registry::error::ParseError
std only.impl Error for ComponentRange
std only.impl Error for ConversionRange
std only.impl Error for DifferentVariant
std only.impl Error for InvalidVariant
std only.impl Error for LengthDelimitedCodecError
impl Error for tokio::net::tcp::split_owned::ReuniteError
impl Error for tokio::net::unix::split_owned::ReuniteError
impl Error for TryCurrentError
impl Error for JoinError
impl Error for AcquireError
impl Error for tokio::sync::mutex::TryLockError
impl Error for tokio::sync::oneshot::error::RecvError
impl Error for tokio::sync::watch::error::RecvError
impl Error for Elapsed
impl Error for tokio::time::error::Error
impl Error for SetGlobalDefaultError
std only.impl Error for tracing_core::metadata::ParseLevelError
std only.impl Error for ParseLevelFilterError
std only.impl Error for tracing_subscriber::filter::directive::ParseError
std only.impl Error for BadName
impl Error for FromEnvError
impl Error for tracing_subscriber::reload::Error
impl Error for TryInitError
std only.impl Error for uint::uint::FromHexError
std only.impl Error for FromStrRadixErr
std only.impl Error for BridgeMessageDispatchError
impl<'a, K, V> Error for alloc::collections::btree::map::entry::OccupiedError<'a, K, V>
impl<'a, K, V> Error for std::collections::hash::map::OccupiedError<'a, K, V>
impl<'a, T> Error for &'a T
impl<E> Error for Box<E>where
E: Error,
impl<H> Error for sp_trie::error::Error<H>
impl<H, CodecError> Error for sp_trie::trie_codec::Error<H, CodecError>
impl<HO, CE> Error for trie_db::proof::verify::Error<HO, CE>
std only.impl<I> Error for ExactlyOneError<I>
use_std only.impl<L, R> Error for Either<L, R>
std only.Either implements Error if both L and R implement it.
Requires crate feature "std"
impl<R> Error for BitIdxError<R>where
R: BitRegister,
std only.impl<T> Error for std::sync::mpmc::error::SendTimeoutError<T>
impl<T> Error for std::sync::mpsc::TrySendError<T>
impl<T> Error for std::sync::poison::TryLockError<T>
impl<T> Error for BitPtrError<T>where
T: BitStore,
std only.impl<T> Error for BitSpanError<T>where
T: BitStore,
std only.impl<T> Error for tokio::sync::mpsc::error::SendTimeoutError<T>
time only.impl<T> Error for tokio::sync::mpsc::error::TrySendError<T>
impl<T> Error for SetError<T>where
T: Debug,
impl<T> Error for ThinBox<T>
impl<T> Error for std::sync::mpsc::SendError<T>
impl<T> Error for PoisonError<T>
impl<T> Error for CapacityError<T>where
T: Any,
std only.Requires features="std".
impl<T> Error for MisalignError<T>
std only.impl<T> Error for FromBitsError<T>
std only.impl<T> Error for futures_channel::mpsc::TrySendError<T>where
T: Any,
impl<T> Error for futures_util::io::split::ReuniteError<T>where
T: Any,
std only.impl<T> Error for PollSendError<T>where
T: Debug,
impl<T> Error for AsyncFdTryNewError<T>
impl<T> Error for tokio::sync::broadcast::error::SendError<T>where
T: Debug,
impl<T> Error for tokio::sync::mpsc::error::SendError<T>
impl<T> Error for tokio::sync::watch::error::SendError<T>
impl<T> Error for Arc<T>
impl<T, E> Error for TrieError<T, E>
std only.impl<T, E> Error for TryChunksError<T, E>
std only.impl<T, E> Error for TryReadyChunksError<T, E>
std only.impl<T, Item> Error for futures_util::stream::stream::split::ReuniteError<T, Item>where
T: Any,
std only.