Enum Error 

#[non_exhaustive]
pub enum Error {
    BadRequest(String),
    Unauthorized,
    Forbidden,
    NotFound,
    PageExpired,
    TooManyRequests,
    ServiceUnavailable,
    Validation(ValidationError),
    Status(StatusCode, String),
    Internal(Error),
}

The error type handlers return. Any anyhow-compatible error converts into Error::Internal with ?.

For a status without its own variant (402, 409, 410, …) use Error::Status, or abort / abort_if:

fn download(order: &Order) -> Result<&'static str> {
    renox::abort_if(!order.paid, StatusCode::PAYMENT_REQUIRED, "Pay for the order first.")?;
    Ok("the file")
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BadRequest(String)

400, with a message that is safe to show visitors.

Unauthorized

401: the request needs a logged-in user.

Forbidden

403: the user may not do this.

NotFound

PageExpired

The CSRF token was missing or wrong, usually because the session expired.

TooManyRequests

A rate limit was hit; see Routes::throttle.

ServiceUnavailable

The app is in maintenance mode.

Validation(ValidationError)

Invalid input; see ValidationError.

Status(StatusCode, String)

Any status, with a message that is safe to show visitors (on the error page, or as message in JSON).

Internal(Error)

500 (409 for a unique-constraint violation); details are shown only in debug.

Implementations

impl Error

pub fn permanent(err: impl Into<Error>) -> Self

An error that retrying can’t fix, e.g. an invalid email address. A job that returns one goes to failed_jobs at once instead of being retried.

pub fn permanent_message(message: impl Display) -> Self

Error::permanent with just a message: Err(Error::permanent_message("the card was declined")).

pub fn is_permanent(&self) -> bool

Whether the error was made with Error::permanent.

pub fn is_retryable(&self) -> bool

Whether the error is a database conflict that retrying may clear (see DbError::is_retryable).

pub fn is_unique_violation(&self) -> bool

Whether the error is a database unique-constraint violation, e.g. a second sign-up with the same email racing past the unique rule.

pub fn status(&self) -> StatusCode

The HTTP status this error responds with.

Trait Implementations

impl Debug for Error

Readable when main returns an error: the message and its causes.

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

Formats the value using the given formatter.

impl<E: Into<Error>> From<E> for Error

fn from(err: E) -> Self

Converts to this type from the input type.

impl From<Errors> for Error

fn from(errors: Errors) -> Self

Converts to this type from the input type.

impl From<ValidationError> for Error

fn from(err: ValidationError) -> Self

Converts to this type from the input type.

impl IntoResponse for Error

fn into_response(self) -> Response

Create a response.