Struct ErrorMessage

pub struct ErrorMessage { /* private fields */ }

To get an ErrorMessage without an underlying Error.

use errors_with_context::ErrorMessage;
ErrorMessage::new("Error description".to_owned());
// prints "Error description" without listing a cause

Most of the time, you need a Result<T, ErrorMessage> instead. ErrorMessage::err does exactly that, so you can immediately throw it with ?:

fn erroring_function() -> Result<String, ErrorMessage> {
    ErrorMessage::err("Error description".to_owned())?
// [...]
}

If you want to manually wrap an Error, there is the function ErrorMessage::with_context.

ErrorMessage::with_context("Error description".to_owned(), io::Error::last_os_error());

Implementations

impl ErrorMessage

pub fn new(message: String) -> ErrorMessage

To get an ErrorMessage without an underlying Error as a cause.

Example:

use errors_with_context::ErrorMessage;
ErrorMessage::new("Error description".to_owned());
// prints "Error description" without listing a cause

pub fn err<T>(message: String) -> Result<T, ErrorMessage>

This function creates a Result<T, ErrorMessage>, so you can immediately throw it with ?.

Example:

fn erroring_function() -> Result<String, ErrorMessage> {
    ErrorMessage::err("Error description".to_owned())?
// [...]
}

pub fn with_context<E: Error + 'static>( message: String, cause: E, ) -> ErrorMessage

This function allows one to manually wrap an Error.

Example:

ErrorMessage::with_context("Error description".to_owned(), io::Error::last_os_error());

Trait Implementations

impl Debug for ErrorMessage

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

Formats the value using the given formatter.

impl Display for ErrorMessage

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

Formats the value using the given formatter.

impl Error for ErrorMessage

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 Serialize for ErrorMessage

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.