Enum RuntimeError 

#[non_exhaustive]
pub enum RuntimeError {
    Config(ConfigError),
    Auth(AuthError),
    Webhook(WebhookError),
    File(FileError),
    Notification(NotificationError),
    Observer(ObserverError),
    Integration(IntegrationError),
    Database(Error),
    RateLimited {
        retry_after: Option<u64>,
    },
    ServiceUnavailable {
        reason: String,
        retry_after: Option<u64>,
    },
    NotFound {
        resource: String,
    },
    Internal {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
}

Unified error type wrapping all domain errors.

RuntimeError aggregates every domain-level error that can surface during request handling. It implements [axum::response::IntoResponse] so that handlers can return Result<_, RuntimeError> directly; the conversion produces an [ErrorResponse] JSON body with the appropriate HTTP status code. Sensitive internal details (database messages, config values) are stripped from the HTTP response and are only present in server-side logs.

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.

Config(ConfigError)

A configuration error, such as an invalid or missing config file.

Auth(AuthError)

An authentication or authorisation error (invalid token, expired session, etc.).

Webhook(WebhookError)

A webhook validation error (bad signature, duplicate event, expired timestamp, etc.).

File(FileError)

A file-handling error (size limit exceeded, unsupported type, virus detected, etc.).

Notification(NotificationError)

A notification delivery error (provider unavailable, circuit open, rate-limited, etc.).

Observer(ObserverError)

An observer/event processing error (invalid condition, action failure, etc.).

Integration(IntegrationError)

An external integration error (search, cache, queue, or connection failure).

Database(Error)

A database-level error propagated from sqlx.

The raw sqlx message is available for logging but is never exposed in HTTP responses (returns a generic “database error” description instead).

RateLimited

The caller has exceeded the configured request rate limit.

retry_after is the number of seconds to wait before retrying, if known.

Fields

retry_after: Option<u64>

Number of seconds to wait before retrying, if known.

ServiceUnavailable

A downstream service or dependency is temporarily unavailable.

retry_after is the number of seconds to wait before retrying, if known.

Fields

reason: String

Human-readable reason for the outage (server-side logs only).

retry_after: Option<u64>

Number of seconds to wait before retrying, if known.

NotFound

The requested resource does not exist.

Fields

resource: String

Description of the resource that was not found.

Internal

An unexpected internal server error.

Use this variant when no more specific variant applies. The message is recorded in server logs but is never forwarded to clients.

Fields

message: String

Internal error message (not forwarded to clients).

source: Option<Box<dyn Error + Send + Sync>>

Optional chained error for structured logging.

Implementations

impl RuntimeError

pub const fn error_code(&self) -> &'static str

Get the error code for this error

pub fn docs_url(&self) -> String

Get documentation URL for this error

Trait Implementations

impl Debug for RuntimeError

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

Formats the value using the given formatter.

impl Display for RuntimeError

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

Formats the value using the given formatter.

impl Error for RuntimeError

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<AuthError> for RuntimeError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<ConfigError> for RuntimeError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<Error> for RuntimeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FileError> for RuntimeError

fn from(source: FileError) -> Self

Converts to this type from the input type.

impl From<IntegrationError> for RuntimeError

fn from(source: IntegrationError) -> Self

Converts to this type from the input type.

impl From<NotificationError> for RuntimeError

fn from(source: NotificationError) -> Self

Converts to this type from the input type.

impl From<ObserverError> for RuntimeError

fn from(source: ObserverError) -> Self

Converts to this type from the input type.

impl From<WebhookError> for RuntimeError

fn from(source: WebhookError) -> Self

Converts to this type from the input type.