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
core
A trait representing the basic expectations for error values.
Re-exported from core
::error::
.
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.
§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
Source§impl dyn Error + Send
impl dyn Error + Send
Source§impl dyn Error + Send + Sync
impl dyn Error + Send + Sync
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>
impl<'a> From<&str> for Box<dyn Error + 'a>
1.0.0 · Source§impl<'a> From<&str> for Box<dyn Error + Send + Sync + 'a>
impl<'a> From<&str> for Box<dyn Error + Send + Sync + '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 + Send + Sync + 'a>
impl<'a, 'b> From<Cow<'b, str>> for Box<dyn Error + Send + Sync + 'a>
Source§fn from(err: Cow<'b, str>) -> Box<dyn Error + Send + Sync + 'a>
fn from(err: Cow<'b, str>) -> Box<dyn Error + Send + Sync + 'a>
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))
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;
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))
1.0.0 · Source§impl<'a, E> From<E> for Box<dyn Error + Send + Sync + 'a>
impl<'a, E> From<E> for Box<dyn Error + Send + Sync + 'a>
Source§fn from(err: E) -> Box<dyn Error + Send + Sync + 'a>
fn from(err: E) -> Box<dyn Error + Send + Sync + 'a>
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<'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 + Send + Sync + 'a>
impl<'a> From<String> for Box<dyn Error + Send + Sync + 'a>
Source§fn from(err: String) -> Box<dyn Error + Send + Sync + 'a>
fn from(err: String) -> Box<dyn Error + Send + Sync + 'a>
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 FromBytesWithNulError
impl Error for GetDisjointMutError
impl Error for devela::_dep::_std::sync::mpmc::RecvTimeoutError
impl Error for devela::_dep::_std::sync::mpmc::TryRecvError
impl Error for CheckedCastError
impl Error for PodCastError
impl Error for FltkError
impl Error for devela::_dep::flume::RecvError
impl Error for devela::_dep::flume::RecvTimeoutError
impl Error for devela::_dep::flume::TryRecvError
impl Error for devela::_dep::gilrs::Error
impl Error for MappingError
impl Error for DistanceModelError
impl Error for devela::_dep::gilrs::ff::Error
impl Error for devela::_dep::image::ImageError
impl Error for devela::_dep::image::flat::Error
impl Error for devela::_dep::kira::backend::cpal::Error
impl Error for FromFileError
impl Error for PortInfoError
impl Error for devela::_dep::midir::SendError
impl Error for ShaderError
impl Error for BuildStreamError
impl Error for DefaultStreamConfigError
impl Error for DeviceNameError
impl Error for PauseStreamError
impl Error for PlayStreamError
impl Error for devela::_dep::rodio::cpal::StreamError
impl Error for SupportedStreamConfigsError
impl Error for DecoderError
impl Error for devela::_dep::rodio::decoder::symphonia::SeekError
impl Error for DevicesError
impl Error for PlayError
impl Error for devela::_dep::rodio::StreamError
impl Error for devela::_dep::rodio::source::SeekError
impl Error for devela::_dep::sdl2::controller::AddMappingError
impl Error for devela::_dep::sdl2::Error
impl Error for devela::_dep::sdl2::IntegerOrSdlError
impl Error for devela::_dep::sdl2::filesystem::PrefPathError
impl Error for devela::_dep::sdl2::messagebox::ShowMessageError
impl Error for devela::_dep::sdl2::render::TargetRenderError
impl Error for devela::_dep::sdl2::render::TextureValueError
impl Error for devela::_dep::sdl2::render::UpdateTextureError
impl Error for devela::_dep::sdl2::render::UpdateTextureYUVError
impl Error for devela::_dep::sdl2::ttf::FontError
impl Error for devela::_dep::sdl2::ttf::InitError
impl Error for devela::_dep::sdl2::url::OpenUrlError
impl Error for devela::_dep::sdl2::video::WindowBuildError
impl Error for devela::_dep::sdl3::IntegerOrSdlError
impl Error for devela::_dep::sdl3::filesystem::PrefPathError
impl Error for devela::_dep::sdl3::gamepad::AddMappingError
impl Error for devela::_dep::sdl3::messagebox::ShowMessageError
impl Error for devela::_dep::sdl3::render::TargetRenderError
impl Error for devela::_dep::sdl3::render::TextureValueError
impl Error for devela::_dep::sdl3::render::UpdateTextureError
impl Error for devela::_dep::sdl3::render::UpdateTextureYUVError
impl Error for devela::_dep::sdl3::url::OpenUrlError
impl Error for devela::_dep::sdl3::video::WindowBuildError
impl Error for devela::_dep::symphonia::core::errors::Error
impl Error for devela::_dep::tokio::sync::broadcast::error::RecvError
impl Error for devela::_dep::tokio::sync::broadcast::error::TryRecvError
impl Error for TryAcquireError
impl Error for devela::_dep::tokio::sync::mpsc::error::TryRecvError
impl Error for devela::_dep::tokio::sync::oneshot::error::TryRecvError
impl Error for devela::_dep::toml_edit::ser::Error
impl Error for devela::_dep::ureq::Error
impl Error for Infallible
impl Error for NumError
impl Error for InvalidText
impl Error for TextError
error
and text··
only.impl Error for UiError
impl Error for AllError
error
only.impl Error for AudioError
audio
only.impl Error for ColorError
color
only.impl Error for DataError
error
and data··
only.impl Error for DataNotEnough
impl Error for DrawError
draw
only.impl Error for devela::all::FontError
font
only.impl Error for devela::all::ImageError
image
only.impl Error for devela::all::LayoutError
layout
only.impl Error for MediaError
media··
only.impl Error for MidiError
midi
only.impl Error for MismatchedBounds
impl Error for NotAvailable
impl Error for PartialSpace
impl Error for SixelError
alloc
and crate feature term
and (crate features io
or std
) and (crate features dep_hashbrown
or std
) and crate feature image
only.impl Error for TimeError
error
and time
only.impl Error for VarError
impl Error for !
impl Error for AllocError
impl Error for TryFromSliceError
impl Error for CharTryFromError
impl Error for DecodeUtf16Error
impl Error for ParseCharError
impl Error for TryFromCharError
impl Error for FromBytesUntilNulError
impl Error for ParseBoolError
impl Error for devela::_core::str::Utf8Error
impl Error for UnorderedKeyError
impl Error for devela::_dep::_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 WriterPanicked
impl Error for ExitStatusError
impl Error for devela::_dep::_std::sync::mpmc::RecvError
impl Error for devela::_dep::_std::time::SystemTimeError
impl Error for devela::_dep::image::error::DecodingError
impl Error for devela::_dep::image::error::EncodingError
impl Error for LimitError
impl Error for ParameterError
impl Error for UnsupportedError
impl Error for devela::_dep::jiff::Error
impl Error for devela::_dep::js_sys::TryFromIntError
impl Error for ResourceLimitReached
impl Error for NonexistentRoute
impl Error for devela::_dep::log::ParseLevelError
impl Error for devela::_dep::midir::InitError
impl Error for UnknownCryptoError
impl Error for DowncastError<'_, '_>
impl Error for DowncastIntoError<'_>
impl Error for PyErr
impl Error for ThreadPoolBuildError
impl Error for devela::_dep::regex_lite::Error
impl Error for BackendSpecificError
impl Error for devela::_dep::rustix::io::Errno
impl Error for SdlError
impl Error for InvalidTextureAccess
impl Error for devela::_dep::sdl3::Error
impl Error for devela::_dep::serde::de::value::Error
impl Error for devela::_dep::simdutf8::basic::Utf8Error
impl Error for devela::_dep::simdutf8::compat::Utf8Error
impl Error for TryCurrentError
impl Error for devela::_dep::tokio::sync::oneshot::error::RecvError
impl Error for AcquireError
impl Error for devela::_dep::tokio::sync::TryLockError
impl Error for devela::_dep::tokio::sync::watch::error::RecvError
impl Error for JoinError
impl Error for devela::_dep::toml_edit::de::Error
impl Error for DatetimeParseError
impl Error for TomlError
impl Error for SetGlobalDefaultError
impl Error for ParseLevelFilterError
impl Error for devela::_dep::tracing::metadata::ParseLevelError
impl Error for InvalidHeaderName
impl Error for InvalidHeaderValue
impl Error for MaxSizeReached
impl Error for ToStrError
impl Error for InvalidMethod
impl Error for InvalidStatusCode
impl Error for devela::_dep::ureq::http::Error
impl Error for InvalidUri
impl Error for InvalidUriParts
impl Error for InvalidChar
impl Error for InvalidUtf8
impl Error for CompressError
impl Error for DecompressError
impl Error for uuid::error::Error
impl Error for AddrParseError
impl Error for DataOverflow
impl Error for TryFromFloatSecsError
impl Error for ElementNotFound
impl Error for FailedErrorConversion
impl Error for devela::all::FmtError
impl Error for IndexOutOfBounds
impl Error for InvalidAxisLength
impl Error for devela::all::IoError
impl Error for JoinPathsError
impl Error for KeyAlreadyExists
impl Error for SetLoggerError
impl Error for devela::all::MemLayoutError
impl Error for MismatchedCapacity
impl Error for MismatchedDimensions
impl Error for MismatchedIndices
impl Error for NodeEmpty
impl Error for NodeLinkNotSet
impl Error for NodeLinkNotUnique
impl Error for NotEnoughElements
impl Error for NotEnoughSpace
impl Error for NotImplemented
impl Error for NotSupported
impl Error for ParseFloatError
impl Error for ParseIntError
impl Error for PartiallyAdded
impl Error for StripPrefixError
impl Error for BorrowError
impl Error for BorrowMutError
impl Error for devela::all::SystemTimeError
std
only.impl Error for AccessError
impl Error for devela::all::TryFromIntError
impl Error for ArenaFull
impl Error for ChunkError
impl Error for DecodeError
impl Error for DecodeErrors
impl Error for DecodeSliceError
impl Error for DecodingError
impl Error for EncodeSliceError
impl Error for EncodingError
impl Error for Errno
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for Error
impl Error for FaceParsingError
impl Error for InsertWithKeyError
impl Error for ParseAlphabetError
impl Error for ParseError
impl Error for PeekError
impl Error for PopError
impl Error for RecvError
impl Error for RecvTimeoutError
impl Error for SelectTimeoutError
impl Error for TryGetError
impl Error for TryRecvError
impl Error for TryReserveError
impl Error for TrySelectError
impl<'a> Error for BufReadDecoderError<'a>
impl<'a> Error for DecodeError<'a>
impl<'a, K, V> Error for devela::_dep::_alloc::collections::btree_map::OccupiedError<'a, K, V>
impl<'a, K, V> Error for devela::_dep::_std::collections::hash_map::OccupiedError<'a, K, V>
impl<'a, T> Error for &'a T
impl<E> Error for PlaySoundError<E>where
E: Debug,
impl<E> Error for Box<E>where
E: Error,
impl<I> Error for ExactlyOneError<I>
impl<I> Error for InputError<I>
impl<I, C> Error for TreeError<I, C>
impl<L, R> Error for Either<L, R>
Either
implements Error
if both L
and R
implement it.
Requires crate feature "use_std"
impl<T> Error for devela::_dep::_std::sync::mpmc::SendTimeoutError<T>
impl<T> Error for devela::_dep::_std::sync::mpmc::TrySendError<T>
impl<T> Error for devela::_dep::flume::SendTimeoutError<T>
impl<T> Error for devela::_dep::flume::TrySendError<T>
impl<T> Error for SetError<T>where
T: Debug,
impl<T> Error for devela::_dep::tokio::sync::mpsc::error::TrySendError<T>
impl<T> Error for devela::all::TryLockError<T>
impl<T> Error for ThinBox<T>
impl<T> Error for devela::_dep::_alloc::sync::Arc<T>
impl<T> Error for devela::_dep::_std::sync::mpmc::SendError<T>
impl<T> Error for devela::_dep::flume::SendError<T>
impl<T> Error for ConnectError<T>
impl<T> Error for devela::_dep::tokio::sync::broadcast::error::SendError<T>where
T: Debug,
impl<T> Error for devela::_dep::tokio::sync::mpsc::error::SendError<T>
impl<T> Error for devela::_dep::tokio::sync::watch::error::SendError<T>
impl<T> Error for CapacityError<T>where
T: Any,
Requires features="std"
.