Enum Reason 

pub enum Reason {
    Deactivated,
    Probation,
    Rejected,
    Timeout,
    GiveUp,
    NoResource,
    Invariant,
    BadFilter,
}

Why a subscription ended (RFC 6665 §4.1.3).

The distinction that matters to a subscriber is whether to try again, and these are not interchangeable about it: deactivated says re-subscribe now, probation says wait, rejected says do not, and noresource says there is nothing left to subscribe to.

Variants

Deactivated

The subscription ended and the subscriber should re-subscribe immediately.

Probation

Ended for now; re-subscribe after retry-after.

Rejected

Refused by policy. Do not re-subscribe.

Timeout

The subscription simply expired.

GiveUp

The notifier could not continue, for a reason of its own.

NoResource

The resource being watched no longer exists.

Invariant

A subscription the notifier can no longer honour in the terms agreed.

BadFilter

The filter was not one the notifier could apply.

Implementations

impl Reason

pub fn as_str(self) -> &'static str

The token as it appears in the header.

pub fn parse(token: &str) -> Option<Self>

The reason a token names.

pub fn should_resubscribe(self) -> bool

Whether a subscriber should try again.

§4.1.3 gives each reason its own answer, and collapsing them is how a client either gives up on a subscription that was only briefly unavailable, or hammers one it has been refused.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl PartialEq for Reason

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Reason

impl Eq for Reason

impl StructuralPartialEq for Reason