Enum NotificationError 

#[non_exhaustive]
pub enum NotificationError {
    Configuration {
        message: String,
    },
    Provider {
        provider: String,
        message: String,
    },
    ProviderUnavailable {
        provider: String,
        retry_after: Option<Duration>,
    },
    InvalidInput {
        message: String,
    },
    Template {
        message: String,
    },
    ProviderRateLimited {
        provider: String,
        seconds: u64,
    },
    CircuitOpen {
        provider: String,
        retry_after: Duration,
    },
    Timeout,
}

Errors that occur during notification delivery (email, SMS, push, etc.).

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.

Configuration

The notification provider is misconfigured (e.g. missing API key or invalid sender address).

Fields

message: String

Description of the configuration problem.

Provider

The notification provider returned an unexpected error response.

Fields

provider: String

Name of the notification provider (e.g. "sendgrid", "twilio").

message: String

Error message from the provider (kept server-side; not forwarded to clients).

ProviderUnavailable

The notification provider is temporarily unreachable or returning 5xx responses.

Fields

provider: String

Name of the provider that is unavailable.

retry_after: Option<Duration>

How long to wait before retrying, if the provider indicated a backoff.

InvalidInput

The notification request contained invalid data (e.g. a malformed recipient address or an empty message body).

Fields

message: String

Description of what was invalid.

Template

An error occurred while rendering the notification template.

Fields

message: String

Description of the template rendering failure.

ProviderRateLimited

The notification provider has rate-limited the sending account.

Fields

provider: String

Name of the provider that applied the rate limit.

seconds: u64

Number of seconds to wait before retrying.

CircuitOpen

The circuit breaker for this provider is open because too many recent requests have failed.

Requests will not be forwarded to the provider until retry_after has elapsed, giving the provider time to recover.

Fields

provider: String

Name of the provider whose circuit is open.

retry_after: Duration

How long to wait before the circuit transitions to half-open.

Timeout

The notification delivery attempt did not complete within the allowed time budget.

Implementations

impl NotificationError

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

Returns a short, stable error code string suitable for API responses and structured logging.

Trait Implementations

impl Debug for NotificationError

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

Formats the value using the given formatter.

impl Display for NotificationError

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

Formats the value using the given formatter.

impl Error for NotificationError

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

fn from(source: NotificationError) -> Self

Converts to this type from the input type.