Struct FerrumError

pub struct FerrumError {
    pub error: Box<dyn Error + Send>,
    pub response: Option<Response>,
}

The type of Errors inside and when using Ferrum.

FerrumError informs its receivers of two things:

• What went wrong
• What to do about it

The error field is responsible for informing receivers of which error occured, and receivers may also modify the error field by layering it (building up a cause chain).

The response field provides a tangible action to be taken if this error is not otherwise handled.

Fields

error: Box<dyn Error + Send>

The underlying error

This can be layered and will be logged at the end of an errored request.

response: Option<Response>

What to do about this error.

This Response will be used when the error-handling flow finishes.

Implementations

impl FerrumError

pub fn new<E: 'static + Error + Send>( error: E, response: Option<Response>, ) -> FerrumError

Create a new FerrumError from an error and a response.

Trait Implementations

impl Debug for FerrumError

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

Formats the value using the given formatter.

impl Display for FerrumError

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

Formats the value using the given formatter.

impl Error for FerrumError

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 source(&self) -> Option<&(dyn Error + 'static)>

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

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 From<FerrumError> for Response

fn from(error: FerrumError) -> HyperResponse

Converts to this type from the input type.