Struct Subscription 

pub struct Subscription {
    pub state: State,
    pub expires: Option<Duration>,
    pub reason: Option<Reason>,
    pub retry_after: Option<Duration>,
}

A parsed Subscription-State (RFC 6665 §4.1.3).

Fields

state: State

Which state.

expires: Option<Duration>

How long is left, for active and pending.

§4.1.3 makes it a SHOULD there and meaningless on terminated.

reason: Option<Reason>

Why it ended, for terminated.

retry_after: Option<Duration>

How long to wait before re-subscribing, when the reason gives one.

Implementations

impl Subscription

pub fn active(expires: Duration) -> Self

An active subscription with this much left.

pub fn terminated(reason: Reason) -> Self

A terminated subscription, with the reason it ended.

pub fn is_terminated(self_: &Self) -> bool

Whether this says the subscription is over.

pub fn parse(value: &[u8]) -> Option<Self>

Read a Subscription-State value.

pub fn to_value(&self) -> String

Render as a Subscription-State value.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl PartialEq for Subscription

fn eq(&self, other: &Subscription) -> 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 Eq for Subscription

impl StructuralPartialEq for Subscription