Enum SubscribeDoneStatusCode 

#[repr(u64)]
pub enum SubscribeDoneStatusCode {
    Unsubscribed = 0,
    InternalError = 1,
    Unauthorized = 2,
    TrackEnded = 3,
    SubscriptionEnded = 4,
    GoingAway = 5,
    Expired = 6,
}

SUBSCRIBE_DONE status codes, from draft-07 section 5.1 “Subscriber Interactions” (Table 3).

The draft introduces the table with: “The application SHOULD use a relevant status code in SUBSCRIBE_DONE, as defined below”. These codes report why a publisher ended a subscription; they are not all failures. Section 6.19 describes the field only as “an integer status code indicating why the subscription ended”.

The Reason text is the whole of what draft-07 says about these seven codes: each of the strings below occurs exactly once in the document, in the table. Reason-only docs here are the complete record, not a truncation.

Variants

Unsubscribed = 0

Unsubscribed

InternalError = 1

Internal Error

Unauthorized = 2

Unauthorized

TrackEnded = 3

Track Ended

SubscriptionEnded = 4

Subscription Ended

GoingAway = 5

Going Away

Expired = 6

Expired

Implementations

impl SubscribeDoneStatusCode

pub const ALL: &[SubscribeDoneStatusCode]

Every SUBSCRIBE_DONE status code draft-07 assigns, in ascending wire order.

This is the set Self::from_u64 accepts, written out so that it can be enumerated: nothing can iterate an enum’s variants, so a caller that wants the registry has to be handed it. Writing it down is also what lets a test state its claims about the registry itself rather than about the range some sweep happens to reach.

pub fn from_u64(v: u64) -> Option<Self>

Convert a raw u64 to a SubscribeDoneStatusCode, if draft-07 defines it.

Returns None for any code the draft does not assign; peers are free to send codes from later drafts or from private extensions.

pub fn as_u64(self) -> u64

Return the raw u64 value of this status code.

Trait Implementations

impl Clone for SubscribeDoneStatusCode

fn clone(&self) -> SubscribeDoneStatusCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubscribeDoneStatusCode

impl Debug for SubscribeDoneStatusCode

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

Formats the value using the given formatter.

impl Eq for SubscribeDoneStatusCode

impl PartialEq for SubscribeDoneStatusCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubscribeDoneStatusCode