Enum Error

pub enum Error {
    ConfigMissingEnv(&'static str),
    Auth(Error),
    User(Error),
    DailyChallenge(Error),
    SerdeJson(Error),
    JsonRejection(JsonRejection),
}

Main Error Types for all axum handlers.

This contains all of the error types from all other modules. In particular, the From trait is used to cast the error types from other modules to this. Moreover, This handles the following:

• Error types from serde_json, if an axum handler fails to serialize to JSON as a response.
• JSON Rejection errors from [axum][axum::extract::rejection::JsonRejection], if an axum handler fails to deserialize the request body to JSON. This occurs if the consumer of the API sends a malformed/incorrect format for the request body.
• Error types from auth.
• Error types from users.

Variants

ConfigMissingEnv(&'static str)

This error will occur if an environment variable imported using get_env() is missing when the server starts up. If you want to import env variables with default value such as PORT, you can use get_env_opt() instead.

Auth(Error)

Errors from auth::Error

User(Error)

Errors from auth::Error

DailyChallenge(Error)

SerdeJson(Error)

Errors from serde_json::Error

JsonRejection(JsonRejection)

This error will occur if a request body is not valid JSON.

Implementations

impl Error

pub fn client_status_error(&self) -> (StatusCode, ClientError)

Maps the injected server error of type Error to a client error ClientError.

Trait Implementations

impl AsRef<str> for Error

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<JsonRejection> for Error

fn from(value: JsonRejection) -> Self

Converts to this type from the input type.

impl IntoResponse for Error

fn into_response(self) -> Response

Initializes errors to client errors with INTERNAL_SERVER_ERROR and injects the server error into the request through the use of extensions.

The injected server error will be retrieved later on and will be mapped to a proper client error.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.