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, demand: &mut Demand<'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");
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.
Provided Methods§
1.30.0 · sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
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"),
}
}
sourcefn description(&self) -> &str
fn description(&self) -> &str
if let Err(e) = "xc".parse::<u32>() {
// Print `e` itself, no need for description().
eprintln!("Error: {e}");
}
sourcefn cause(&self) -> Option<&dyn Error>
fn cause(&self) -> Option<&dyn Error>
sourcefn provide<'a>(&'a self, demand: &mut Demand<'a>)
fn provide<'a>(&'a self, demand: &mut Demand<'a>)
error_generic_member_access
)Provides type based access to context intended for error reports.
Used in conjunction with Demand::provide_value
and Demand::provide_ref
to extract
references to member variables from dyn Error
trait objects.
Example
#![feature(provide_any)]
#![feature(error_generic_member_access)]
use core::fmt;
use core::any::Demand;
#[derive(Debug)]
struct MyBacktrace {
// ...
}
impl MyBacktrace {
fn new() -> MyBacktrace {
// ...
}
}
#[derive(Debug)]
struct SourceError {
// ...
}
impl fmt::Display for SourceError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Example Source Error")
}
}
impl std::error::Error for SourceError {}
#[derive(Debug)]
struct Error {
source: SourceError,
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, demand: &mut Demand<'a>) {
demand
.provide_ref::<MyBacktrace>(&self.backtrace)
.provide_ref::<dyn std::error::Error + 'static>(&self.source);
}
}
fn main() {
let backtrace = MyBacktrace::new();
let source = SourceError {};
let error = Error { source, backtrace };
let dyn_error = &error as &dyn std::error::Error;
let backtrace_ref = dyn_error.request_ref::<MyBacktrace>().unwrap();
assert!(core::ptr::eq(&error.backtrace, backtrace_ref));
}
Implementations§
source§impl<'a> dyn Error + 'a
impl<'a> dyn Error + 'a
sourcepub fn request_ref<T>(&'a self) -> Option<&'a T>where
T: 'static + ?Sized,
🔬This is a nightly-only experimental API. (error_generic_member_access
)
pub fn request_ref<T>(&'a self) -> Option<&'a T>where T: 'static + ?Sized,
error_generic_member_access
)Request a reference of type T
as context about this error.
sourcepub fn request_value<T>(&'a self) -> Option<T>where
T: 'static,
🔬This is a nightly-only experimental API. (error_generic_member_access
)
pub fn request_value<T>(&'a self) -> Option<T>where T: 'static,
error_generic_member_access
)Request a value of type T
as context about this error.
source§impl dyn Error + 'static
impl dyn Error + 'static
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 + 'static
impl dyn Error + Send + 'static
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
.
sourcepub fn request_ref<T>(&self) -> Option<&T>where
T: 'static + ?Sized,
🔬This is a nightly-only experimental API. (error_generic_member_access
)
pub fn request_ref<T>(&self) -> Option<&T>where T: 'static + ?Sized,
error_generic_member_access
)Request a reference of type T
as context about this error.
sourcepub fn request_value<T>(&self) -> Option<T>where
T: 'static,
🔬This is a nightly-only experimental API. (error_generic_member_access
)
pub fn request_value<T>(&self) -> Option<T>where T: 'static,
error_generic_member_access
)Request a value of type T
as context about this error.
source§impl dyn Error + Sync + Send + 'static
impl dyn Error + Sync + Send + 'static
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
.
sourcepub fn request_ref<T>(&self) -> Option<&T>where
T: 'static + ?Sized,
🔬This is a nightly-only experimental API. (error_generic_member_access
)
pub fn request_ref<T>(&self) -> Option<&T>where T: 'static + ?Sized,
error_generic_member_access
)Request a reference of type T
as context about this error.
sourcepub fn request_value<T>(&self) -> Option<T>where
T: 'static,
🔬This is a nightly-only experimental API. (error_generic_member_access
)
pub fn request_value<T>(&self) -> Option<T>where T: 'static,
error_generic_member_access
)Request a value of type T
as context about this error.
source§impl dyn Error + 'static
impl dyn Error + 'static
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 From<&str> for Box<dyn Error + 'static, Global>
impl From<&str> for Box<dyn Error + 'static, Global>
source§impl<'a> From<&str> for Box<dyn Error + Sync + Send + 'a, Global>
impl<'a> From<&str> for Box<dyn Error + Sync + Send + 'a, Global>
1.22.0 · source§impl<'a> From<Cow<'a, str>> for Box<dyn Error + 'static, Global>
impl<'a> From<Cow<'a, str>> for Box<dyn Error + 'static, Global>
1.22.0 · source§impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Sync + Send + 'a, Global>
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Sync + Send + 'a, Global>
source§fn from(err: Cow<'b, str>) -> Box<dyn Error + Sync + Send + 'a, Global>
fn from(err: Cow<'b, str>) -> Box<dyn Error + Sync + Send + 'a, Global>
Converts a Cow
into a box of dyn Error
+ Send
+ Sync
.
Examples
use std::error::Error;
use std::mem;
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!(
mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))
source§impl<'a, E> From<E> for Box<dyn Error + 'a, Global>where
E: Error + 'a,
impl<'a, E> From<E> for Box<dyn Error + 'a, Global>where E: Error + 'a,
source§fn from(err: E) -> Box<dyn Error + 'a, Global>
fn from(err: E) -> Box<dyn Error + 'a, Global>
Converts a type of Error
into a box of dyn Error
.
Examples
use std::error::Error;
use std::fmt;
use std::mem;
#[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 == mem::size_of_val(&an_error));
let a_boxed_error = Box::<dyn Error>::from(an_error);
assert!(mem::size_of::<Box<dyn Error>>() == mem::size_of_val(&a_boxed_error))
source§impl<'a, E> From<E> for Box<dyn Error + Sync + Send + 'a, Global>where
E: Error + Send + Sync + 'a,
impl<'a, E> From<E> for Box<dyn Error + Sync + Send + 'a, Global>where E: Error + Send + Sync + 'a,
source§fn from(err: E) -> Box<dyn Error + Sync + Send + 'a, Global>
fn from(err: E) -> Box<dyn Error + Sync + Send + 'a, Global>
Converts a type of Error
+ Send
+ Sync
into a box of
dyn Error
+ Send
+ Sync
.
Examples
use std::error::Error;
use std::fmt;
use std::mem;
#[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 == mem::size_of_val(&an_error));
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(an_error);
assert!(
mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))
1.6.0 · source§impl From<String> for Box<dyn Error + 'static, Global>
impl From<String> for Box<dyn Error + 'static, Global>
source§impl From<String> for Box<dyn Error + Sync + Send + 'static, Global>
impl From<String> for Box<dyn Error + Sync + Send + 'static, Global>
source§fn from(err: String) -> Box<dyn Error + Sync + Send + 'static, Global>
fn from(err: String) -> Box<dyn Error + Sync + Send + 'static, Global>
Converts a String
into a box of dyn Error
+ Send
+ Sync
.
Examples
use std::error::Error;
use std::mem;
let a_string_error = "a string error".to_string();
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(a_string_error);
assert!(
mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))
Implementors§
impl !Error for &str
impl Error for druid::PlatformError
impl Error for ColorParseError
impl Error for druid::piet::Error
impl Error for ImageError
impl Error for druid::piet::image_crate::flat::Error
impl Error for druid::piet::kurbo::SvgParseError
impl Error for druid::piet::cairo::BorrowError
impl Error for druid::piet::cairo::Error
impl Error for IoError
impl Error for CvtError
impl Error for IConvError
impl Error for InvalidCharError
impl Error for Infallible
impl Error for VarError
impl Error for RecvTimeoutError
impl Error for std::sync::mpsc::TryRecvError
impl Error for FluentError
impl Error for ErrorKind
impl Error for simplecss::Error
impl Error for usvg::error::Error
impl Error for !
impl Error for MissingKeyError
impl Error for ExtEventError
impl Error for ValueTypeError
impl Error for ValidationError
impl Error for druid::piet::image_crate::error::DecodingError
impl Error for druid::piet::image_crate::error::EncodingError
impl Error for LimitError
impl Error for ParameterError
impl Error for UnsupportedError
impl Error for BoolError
impl Error for druid::piet::cairo::glib::Error
impl Error for FutureWithTimeoutError
impl Error for GlibNoneError
impl Error for ValueTypeMismatchError
impl Error for VariantTypeMismatchError
impl Error for AllocError
impl Error for LayoutError
impl Error for TryFromSliceError
impl Error for druid::piet::cairo::glib::bitflags::_core::cell::BorrowError
impl Error for BorrowMutError
impl Error for CharTryFromError
impl Error for DecodeUtf16Error
impl Error for ParseCharError
impl Error for TryFromCharError
impl Error for FromBytesUntilNulError
impl Error for FromBytesWithNulError
impl Error for druid::piet::cairo::glib::bitflags::_core::fmt::Error
impl Error for AddrParseError
impl Error for ParseFloatError
impl Error for ParseIntError
impl Error for TryFromIntError
impl Error for ParseBoolError
impl Error for Utf8Error
impl Error for TryFromFloatSecsError
impl Error for TryReserveError
impl Error for FromVecWithNulError
impl Error for IntoStringError
impl Error for NulError
impl Error for FromUtf8Error
impl Error for FromUtf16Error
impl Error for JoinPathsError
impl Error for WriterPanicked
impl Error for std::io::error::Error
impl Error for StripPrefixError
impl Error for ExitStatusError
impl Error for RecvError
impl Error for AccessError
impl Error for SystemTimeError
impl Error for CompressError
impl Error for DecompressError
impl Error for ParserError
impl Error for log::ParseLevelError
impl Error for SetLoggerError
impl Error for SetGlobalDefaultError
impl Error for tracing_core::metadata::ParseLevelError
impl Error for ParseLevelFilterError
impl Error for ParseError
impl Error for BadName
impl Error for FromEnvError
impl Error for tracing_subscriber::reload::Error
impl Error for TryInitError
impl Error for Aborted
impl Error for Canceled
impl Error for Cancelled
impl Error for CaseFoldError
impl Error for DecodeError
impl Error for DecodingError
impl Error for DecodingError
impl Error for DecodingFormatError
impl Error for EncodingError
impl Error for EncodingError
impl Error for EnterError
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for FaceParsingError
impl Error for FilterValueListParserError
impl Error for LanguageIdentifierError
impl Error for LzwError
impl Error for SendError
impl Error for SpawnError
impl Error for StreamError
impl Error for SvgParseError
impl Error for TryRecvError
impl Error for UnicodeWordError
impl Error for UnrecognizedCodeError
impl Error for UnrecognizedKeyError
impl Error for ViewBoxError
impl<'a, K, V> Error for alloc::collections::btree::map::entry::OccupiedError<'a, K, V, Global>where K: Debug + Ord, V: Debug,
impl<'a, K, V> Error for std::collections::hash::map::OccupiedError<'a, K, V>where K: Debug, V: Debug,
impl<'a, T> Error for &'a Twhere T: Error + ?Sized,
impl<E> Error for ValueTypeMismatchOrNoneError<E>where E: Error,
impl<I> Error for GlibNoneOrInvalidError<I>where I: Error,
impl<T> Error for std::sync::mpsc::TrySendError<T>where T: Send,
impl<T> Error for TryLockError<T>
impl<T> Error for Box<T, Global>where T: Error,
impl<T> Error for ThinBox<T>where T: Error + ?Sized,
impl<T> Error for Arc<T>where T: Error + ?Sized,
impl<T> Error for std::sync::mpsc::SendError<T>where T: Send,
impl<T> Error for PoisonError<T>
impl<T> Error for CapacityError<T>where T: Any,
Requires features="std"
.