Struct error_chain::example_generated::Error
source · [−]pub struct Error(pub ErrorKind, _);
Expand description
The Error type.
This tuple struct is made of two elements:
- an
ErrorKind
which is used to determine the type of the error. - An internal
State
, not meant for direct use outside oferror_chain
internals, containing:- a backtrace, generated when the error is created.
- an error chain, used for the implementation of
Error::cause()
.
Tuple Fields
0: ErrorKind
The kind of the error.
Implementations
sourceimpl Error
impl Error
sourcepub fn from_kind(kind: ErrorKind) -> Error
pub fn from_kind(kind: ErrorKind) -> Error
Constructs an error from a kind, and generates a backtrace.
sourcepub fn with_chain<E, K>(error: E, kind: K) -> Error where
E: Error + Send + 'static,
K: Into<ErrorKind>,
pub fn with_chain<E, K>(error: E, kind: K) -> Error where
E: Error + Send + 'static,
K: Into<ErrorKind>,
Constructs a chained error from another error and a kind, and generates a backtrace.
sourcepub fn with_boxed_chain<K>(error: Box<dyn Error + Send>, kind: K) -> Error where
K: Into<ErrorKind>,
pub fn with_boxed_chain<K>(error: Box<dyn Error + Send>, kind: K) -> Error where
K: Into<ErrorKind>,
Construct a chained error from another boxed error and a kind, and generates a backtrace
sourcepub fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = &'a dyn Error;
pub fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = &'a dyn Error;
Iterates over the error chain.
sourcepub fn backtrace(&self) -> Option<&Backtrace>
pub fn backtrace(&self) -> Option<&Backtrace>
Returns the backtrace associated with this error.
sourcepub fn chain_err<F, EK>(self, error: F) -> Error where
F: FnOnce() -> EK,
EK: Into<ErrorKind>,
pub fn chain_err<F, EK>(self, error: F) -> Error where
F: FnOnce() -> EK,
EK: Into<ErrorKind>,
Extends the error chain with a new entry.
sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
A short description of the error.
This method is identical to Error::description()
Trait Implementations
sourceimpl ChainedError for Error
impl ChainedError for Error
sourcefn from_kind(kind: Self::ErrorKind) -> Self
fn from_kind(kind: Self::ErrorKind) -> Self
Constructs an error from a kind, and generates a backtrace.
sourcefn with_chain<E, K>(error: E, kind: K) -> Self where
E: Error + Send + 'static,
K: Into<Self::ErrorKind>,
fn with_chain<E, K>(error: E, kind: K) -> Self where
E: Error + Send + 'static,
K: Into<Self::ErrorKind>,
Constructs a chained error from another error and a kind, and generates a backtrace.
sourcefn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = &'a dyn Error;
fn iter(&self) -> Iter<'_>ⓘNotable traits for Iter<'a>impl<'a> Iterator for Iter<'a> type Item = &'a dyn Error;
Iterates over the error chain.
sourcefn chain_err<F, EK>(self, error: F) -> Self where
F: FnOnce() -> EK,
EK: Into<ErrorKind>,
fn chain_err<F, EK>(self, error: F) -> Self where
F: FnOnce() -> EK,
EK: Into<ErrorKind>,
Extends the error chain with a new entry.
sourcefn display_chain<'a>(&'a self) -> DisplayChain<'a, Self>
fn display_chain<'a>(&'a self) -> DisplayChain<'a, Self>
Returns an object which implements Display
for printing the full
context of this error. Read more
sourceimpl Error for Error
impl Error for Error
sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
Auto Trait Implementations
impl !RefUnwindSafe for Error
impl Send for Error
impl !Sync for Error
impl Unpin for Error
impl !UnwindSafe for Error
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more