Struct SingleStructError

pub struct SingleStructError<T: Debug + Display> { /* private fields */ }

A container implementing the std::error::Error trait.

Instances always carry a corresponding kind of type T and may be extended with a custom error message and source.

This type is mainly designed to accommodate for the single struct error design pattern.

When used in a specialized context it is recommended to use a type alias (i.e. type MyError = SingleStructError<MyErrorKind>).

Implementations

impl<T: Debug + Display> SingleStructError<T>

pub fn new(kind: T) -> Self

Constructs a new SingleStructError.

pub fn kind(&self) -> &T

Returns a reference to the corresponding kind of this error.

pub fn into_kind(self) -> T

Converts this error into the corresponding kind of this error.

pub fn custom_message(&self) -> Option<&str>

Returns a reference to the custom message of the SingleStructError if it was set.

pub fn source_ref(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

Returns a reference to the attached source of the SingleStructError if it was set.

pub fn into_source(self) -> Option<Box<dyn Error + Send + Sync + 'static>>

Converts this error into the source error if it was set.

pub fn with_source( self, source: impl Into<Box<dyn Error + Send + Sync + 'static>>, ) -> Self

Updates the source of the SingleStructError.

pub fn with_custom_message(self, message: impl Into<Cow<'static, str>>) -> Self

Updates the custom message of the SingleStructError.

Trait Implementations

impl<T: Debug + Debug + Display> Debug for SingleStructError<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Display + Debug> Display for SingleStructError<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Debug + Display> Error for SingleStructError<T>

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<T: Debug + Display> From<Box<Extensive<T>>> for SingleStructError<T>

fn from(extensive: Box<Extensive<T>>) -> Self

Converts to this type from the input type.

impl<T: Debug + Display> From<T> for SingleStructError<T>

fn from(kind: T) -> Self

Converts to this type from the input type.