Enum SubscribeDoneStatusCode 

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

SUBSCRIBE_DONE status codes (draft-08, section 7.19 “SUBSCRIBE_DONE”).

The draft calls these status codes rather than error codes. Section 7.19: “The Status Code indicates why the subscription ended, and whether it was an error.” Both outcomes appear in the registry, so receiving one of these does not by itself mean the subscription failed.

Note that 0x2 is Track Ended here, whereas the four request-scoped registries in this draft assign Timeout to 0x2.

Variants

InternalError = 0

Internal Error

Unauthorized = 1

Unauthorized

TrackEnded = 2

Track Ended

SubscriptionEnded = 3

Subscription Ended

GoingAway = 4

Going Away

Expired = 5

Expired

TooFarBehind = 6

Too Far Behind

Implementations

impl SubscribeDoneStatusCode

pub const ALL: &[SubscribeDoneStatusCode]

Every SUBSCRIBE_DONE status code draft-08 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 valid.

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