pub trait StdError: 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.0.0 · Source§impl<'a> From<&str> for Box<dyn Error + Sync + Send + 'a>
impl<'a> From<&str> for Box<dyn Error + Sync + Send + 'a>
1.22.0 · Source§impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + 'a>
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + 'a>
1.22.0 · Source§impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Sync + Send + 'a>
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Sync + Send + 'a>
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,
impl<'a, E> From<E> for Box<dyn Error + 'a>where
E: Error + 'a,
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>
impl<'a, E> From<E> for Box<dyn Error + Sync + Send + 'a>
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>
impl<'a> From<String> for Box<dyn Error + 'a>
1.0.0 · Source§impl<'a> From<String> for Box<dyn Error + Sync + Send + 'a>
impl<'a> From<String> for Box<dyn Error + Sync + Send + 'a>
Source§impl SinkError for Box<dyn Error>
A Box<dyn std::error::Error> can be used as an error for Sink
implementations out of the box.
impl SinkError for Box<dyn Error>
A Box<dyn std::error::Error> can be used as an error for Sink
implementations out of the box.
Source§fn error_message<T>(message: T) -> Box<dyn Error>where
T: Display,
fn error_message<T>(message: T) -> Box<dyn Error>where
T: Display,
std::fmt::Display trait into an error.Source§fn error_io(err: Error) -> Self
fn error_io(err: Error) -> Self
Source§fn error_config(err: ConfigError) -> Self
fn error_config(err: ConfigError) -> Self
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 std::sync::mpsc::RecvTimeoutError
impl Error for std::sync::mpsc::TryRecvError
impl Error for BytesRejection
impl Error for FailedToBufferBody
impl Error for StringRejection
impl Error for ExtensionRejection
impl Error for FormRejection
impl Error for HostRejection
impl Error for JsonRejection
impl Error for MatchedPathRejection
impl Error for PathRejection
impl Error for QueryRejection
impl Error for RawFormRejection
impl Error for RawPathParamsRejection
impl Error for base64::alphabet::ParseAlphabetError
impl Error for base64::alphabet::ParseAlphabetError
impl Error for base64::decode::DecodeError
impl Error for base64::decode::DecodeError
impl Error for DecodeSliceError
impl Error for EncodeSliceError
impl Error for RoundingError
impl Error for clap::parser::error::MatchesError
impl Error for clap_builder::parser::error::MatchesError
impl Error for crossbeam_channel::err::RecvTimeoutError
impl Error for crossbeam_channel::err::TryRecvError
impl Error for envy::error::Error
impl Error for grep_printer::color::ColorError
impl Error for grep_printer::color::ColorError
impl Error for ConfigError
impl Error for FromHexError
impl Error for httparse::Error
impl Error for humantime::date::Error
impl Error for humantime::duration::Error
impl Error for GetTimezoneError
impl Error for icu_collections::codepointtrie::error::Error
impl Error for icu_locale_core::parser::errors::ParseError
impl Error for PreferencesParseError
impl Error for ignore::Error
impl Error for indexmap::GetDisjointMutError
impl Error for InsertError
impl Error for matchit::error::MatchError
impl Error for nix::Error
impl Error for nix::Error
impl Error for nix::errno::consts::Errno
impl Error for nix::errno::consts::Errno
impl Error for nix::errno::consts::Errno
impl Error for ProcError
impl Error for BernoulliError
impl Error for WeightedError
impl Error for rand_distr::binomial::Error
impl Error for rand_distr::cauchy::Error
impl Error for rand_distr::dirichlet::Error
impl Error for rand_distr::exponential::Error
impl Error for rand_distr::frechet::Error
impl Error for BetaError
impl Error for ChiSquaredError
impl Error for rand_distr::gamma::Error
impl Error for FisherFError
impl Error for rand_distr::geometric::Error
impl Error for rand_distr::gumbel::Error
impl Error for rand_distr::hypergeometric::Error
impl Error for rand_distr::inverse_gaussian::Error
impl Error for rand_distr::normal::Error
impl Error for rand_distr::normal_inverse_gaussian::Error
impl Error for rand_distr::pareto::Error
impl Error for PertError
impl Error for rand_distr::poisson::Error
impl Error for rand_distr::skew_normal::Error
impl Error for TriangularError
impl Error for rand_distr::weibull::Error
impl Error for ZetaError
impl Error for ZipfError
impl Error for regex_automata::dfa::automaton::StartError
impl Error for regex_automata::hybrid::error::StartError
impl Error for regex_syntax::error::Error
impl Error for regex::error::Error
impl Error for ropey::Error
impl Error for roxmltree::parse::Error
impl Error for webpki::error::Error
impl Error for rustls::error::Error
impl Error for serde_urlencoded::ser::Error
impl Error for slab::GetDisjointMutError
impl Error for strsim::StrSimError
impl Error for strsim::StrSimError
impl Error for time::error::Error
impl Error for tinystr::error::ParseError
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 toml::ser::Error
impl Error for toml_edit::ser::Error
impl Error for ucd_trie::owned::Error
impl Error for ParseQuantityError
impl Error for url::parser::ParseError
impl Error for ErrorKind
impl Error for xmlparser::error::Error
impl Error for StreamError
impl Error for ZeroTrieBuildError
impl Error for UleError
impl Error for !
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 alloc::string::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 core::fmt::Error
impl Error for core::net::parser::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 core::str::error::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
impl Error for aho_corasick::util::error::MatchError
impl Error for aho_corasick::util::primitives::PatternIDError
impl Error for aho_corasick::util::primitives::StateIDError
impl Error for axum_core::error::Error
impl Error for InvalidUtf8
impl Error for axum_core::extract::rejection::LengthLimitError
impl Error for UnknownBodyError
impl Error for FailedToDeserializePathParams
impl Error for InvalidUtf8InPathParam
impl Error for FailedToDeserializeForm
impl Error for FailedToDeserializeFormBody
impl Error for FailedToDeserializeQueryString
impl Error for FailedToResolveHost
impl Error for InvalidFormContentType
impl Error for JsonDataError
impl Error for JsonSyntaxError
impl Error for MatchedPathMissing
impl Error for MissingExtension
impl Error for MissingJsonContentType
impl Error for MissingPathParams
impl Error for bitflags::parser::ParseError
impl Error for bstr::ext_vec::FromUtf8Error
impl Error for bstr::utf8::Utf8Error
impl Error for TryGetError
impl Error for chrono_tz::timezones::ParseError
impl Error for chrono::format::ParseError
impl Error for ParseMonthError
impl Error for OutOfRange
impl Error for OutOfRangeError
impl Error for ParseWeekdayError
impl Error for clap::error::Error
impl Error for crossbeam_channel::err::RecvError
impl Error for SelectTimeoutError
impl Error for TrySelectError
impl Error for deranged::ParseIntError
impl Error for deranged::TryFromIntError
impl Error for CompressError
impl Error for DecompressError
impl Error for futures_channel::mpsc::SendError
impl Error for futures_channel::mpsc::TryRecvError
impl Error for Canceled
impl Error for SpawnError
impl Error for Aborted
impl Error for getrandom::error::Error
impl Error for globset::Error
impl Error for GlobError
impl Error for ParseSizeError
impl Error for InvalidPatternError
impl Error for CommandError
impl Error for NoError
impl Error for HyperlinkFormatError
impl Error for grep_regex::error::Error
impl Error for h2::error::Error
impl Error for RenderError
impl Error for TemplateError
impl Error for http_body::limited::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 InvalidNameError
impl Error for hyper::error::Error
impl Error for DataError
impl Error for Errors
impl Error for indexmap::TryReserveError
impl Error for PrefixLenError
impl Error for ipnet::parser::AddrParseError
impl Error for log::ParseLevelError
impl Error for SetLoggerError
impl Error for FromStrError
impl Error for minijinja::error::Error
impl Error for ClearEnvError
impl Error for FloatIsNan
impl Error for EncodingError
impl Error for ReadError
impl Error for rand_core::error::Error
impl Error for ThreadPoolBuildError
impl Error for regex_automata::dfa::dense::BuildError
impl Error for regex_automata::dfa::onepass::BuildError
impl Error for regex_automata::hybrid::error::BuildError
impl Error for CacheError
impl Error for regex_automata::meta::error::BuildError
impl Error for regex_automata::nfa::thompson::error::BuildError
impl Error for GroupInfoError
impl Error for UnicodeWordBoundaryError
impl Error for regex_automata::util::primitives::PatternIDError
impl Error for SmallIndexError
impl Error for regex_automata::util::primitives::StateIDError
impl Error for regex_automata::util::search::MatchError
impl Error for PatternSetInsertError
impl Error for DeserializeError
impl Error for SerializeError
impl Error for regex_syntax::ast::Error
impl Error for regex_syntax::hir::Error
impl Error for CaseFoldError
impl Error for UnicodeWordError
impl Error for reqwest::error::Error
impl Error for rustix::backend::io::errno::Errno
impl Error for webpki::subject_name::dns_name::InvalidDnsNameError
impl Error for webpki::subject_name::ip_address::AddrParseError
impl Error for rustls::dns_name::InvalidDnsNameError
impl Error for SignError
impl Error for serde_json::error::Error
impl Error for PathPersistError
impl Error for tera::errors::Error
impl Error for ColorChoiceParseError
impl Error for ParseColorError
impl Error for ComponentRange
impl Error for ConversionRange
impl Error for DifferentVariant
impl Error for InvalidVariant
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 toml::datetime::DatetimeParseError
impl Error for toml::de::Error
impl Error for toml::de::Error
impl Error for toml::ser::Error
impl Error for toml_datetime::datetime::DatetimeParseError
impl Error for toml_edit::de::Error
impl Error for TomlError
impl Error for None
impl Error for SetGlobalDefaultError
impl Error for tracing_core::metadata::ParseLevelError
impl Error for ParseLevelFilterError
impl Error for walkdir::error::Error
impl Error for gosh_remote::cli::de::value::Error
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<A, S, V> Error for ConvertError<A, S, V>
impl<E> Error for Err<E>where
E: Debug,
impl<E> Error for ParseNotNanError<E>
impl<E> Error for Box<E>where
E: Error,
impl<E> Error for serde_path_to_error::Error<E>where
E: Error,
impl<F> Error for clap_builder::error::Error<F>where
F: ErrorFormatter,
impl<F> Error for PersistError<F>
impl<I> Error for ExactlyOneError<I>
impl<I> Error for nom::error::Error<I>
impl<I> Error for nom::error::VerboseError<I>
impl<I> Error for InputError<I>
impl<I, C> Error for TreeError<I, C>
impl<I, C> Error for winnow::error::VerboseError<I, C>
impl<K, V> Error for TryIntoHeaderError<K, V>
impl<L, R> Error for Either<L, R>
Either implements Error if both L and R implement it.
Requires crate feature "std"