Struct UnexpectedError

pub struct UnexpectedError { /* private fields */ }

When things went wrong, but you don’t know why.

UnexpectedError is designed for failure scenarios that the application wasn’t explicitly prepared to handle. It works, in particular, as the “catch-all” variant in an error enum.

Example

use pavex::error::UnexpectedError;
use pavex::response::Response;

#[derive(Debug, thiserror::Error)]
pub enum HandlerError {
    // One variant for each kind of known issue
    // that might occur in the request handler.
    #[error(transparent)]
    Authorization(#[from] AuthorizationError),
    #[error(transparent)]
    Database(#[from] DatabaseError),
    // [...]
    // Followed by the catch-all variant.
    #[error(transparent)]
    Unexpected(#[from] UnexpectedError),
}

pub async fn request_handler() -> Result<Response, HandlerError> {
    // [...]
}

Error message

The error message is always the same when using UnexpectedError: “An unexpected error occurred”. This is intentional, as we don’t want to leak any sensitive information or implementation details to the client. The full error details are still available when walking the source error chain and will be captured in your logs if you have a suitable error observer in place.

Implementations

impl UnexpectedError

pub fn new<E>(error: E) -> Self

where E: Into<Box<dyn Error + Send + Sync>>,

Create a new UnexpectedError from a boxable error.

pub fn into_inner(self) -> Box<dyn Error + Send + Sync>

Convert UnexpectedError back into the underlying boxed error.

pub fn inner_ref(&self) -> &(dyn Error + Send + Sync)

Return a reference to the underlying boxed error.

Trait Implementations

impl Debug for UnexpectedError

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

Formats the value using the given formatter.

impl Display for UnexpectedError

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

Formats the value using the given formatter.

impl Error for UnexpectedError

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.