Enum SubscribeDoneStatusCode 

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

SUBSCRIBE_DONE status codes (draft-13 Section 8.12).

Carried in the Status Code field of SUBSCRIBE_DONE, described by the draft as “an integer status code indicating why the subscription ended”. This is a status registry, not an error registry: 0x0 is Internal Error rather than a success value, and every code describes a way a subscription can end.

Draft-14 renamed the message to PUBLISH_DONE and moved these eight assignments into an IANA registry (its Section 13.1.3) with the same codes in the same order, adding the ALLCAPS names this draft lacks.

Variants

InternalError = 0

Internal Error — An implementation specific or generic error occurred.

Unauthorized = 1

Unauthorized — The subscriber is no longer authorized to subscribe to the given track.

TrackEnded = 2

Track Ended — The track is no longer being published.

SubscriptionEnded = 3

Subscription Ended — The publisher reached the end of an associated Subscribe filter.

GoingAway = 4

Going Away — The subscriber or publisher issued a GOAWAY message.

Expired = 5

Expired — The publisher reached the timeout specified in SUBSCRIBE_OK.

TooFarBehind = 6

Too Far Behind — The publisher’s queue of objects to be sent to the given subscriber exceeds its implementation defined limit.

MalformedTrack = 7

Malformed Track — A relay publisher detected the track was malformed (see Section 2.5).

Implementations

impl SubscribeDoneStatusCode

pub const ALL: &[SubscribeDoneStatusCode]

Every SUBSCRIBE_DONE status code draft-13 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