Enum PushError 

pub enum PushError {
    Unregistered,
    Rejected(String),
    Transient {
        message: String,
        retry_after: Option<Duration>,
    },
}

Push failures. Unregistered is separated because the caller must act on it — the recipient is dead and should be pruned — where the others are transient or a bad request.

The two variants that carry provider text are sanitized in Display, the same way DbError’s and MailError’s are (issue #235). What an adapter wraps is the provider’s own words, and a push endpoint or a device token is exactly the kind of value that rides in them. Display therefore runs it through crate::logging::scrub_text; Debug still shows the raw string for tests.

Variants

Unregistered

The provider says the recipient is no longer valid (APNs 410, Web Push 410, FCM UNREGISTERED): delete it.

This is a delete instruction, not a failed send, and an adapter should map only a status whose sole meaning is “gone” onto it. A status a misrouted proxy can also produce — Web Push 404, which RFC 8030 never defines as gone — belongs in Transient: the cost of a wrong Transient is some wasted sends, and a wrongly-pruned Web Push subscription cannot be recreated server-side at all, only by the browser subscribing again.

Rejected(String)

The provider rejected the request (a 4xx that is not 410), or the adapter does not serve this recipient’s transport; not retryable without a change.

Transient

A transient failure (a 5xx, a 429, a transport error): retry later, and not before retry_after when the provider named one (APNs 429, FCM RESOURCE_EXHAUSTED/UNAVAILABLE, Web Push 429/503 — all carry Retry-After).

Fields

message: String

retry_after: Option<Duration>

Implementations

impl PushError

pub fn transient(message: impl Into<String>) -> Self

A retryable failure with no provider-supplied delay.

pub fn transient_after( message: impl Into<String>, retry_after: Option<Duration>, ) -> Self

A retryable failure the provider asked us to hold off on.

pub fn unsupported_recipient(recipient: &Recipient) -> Self

The rejection an adapter returns for a transport it does not serve. RoutingPush exists so a venture never has to see this.

pub fn retry_after(&self) -> Option<Duration>

How long the provider asked the caller to wait, where it said.

Trait Implementations

impl Clone for PushError

fn clone(&self) -> PushError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PushError

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

Formats the value using the given formatter.

impl Display for PushError

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

Formats the value using the given formatter.

impl Eq for PushError

impl Error for PushError

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 PartialEq for PushError

fn eq(&self, other: &PushError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PushError