Enum SubscribeErrorCode 

#[repr(u64)]
pub enum SubscribeErrorCode {
    InternalError = 0,
    InvalidRange = 1,
    RetryTrackAlias = 2,
    TrackDoesNotExist = 3,
    Unauthorized = 4,
    Timeout = 5,
}

SUBSCRIBE_ERROR codes, from draft-07 section 5.1 “Subscriber Interactions” (Table 2).

The draft introduces the table with: “The application SHOULD use a relevant error code in SUBSCRIBE_ERROR, as defined below”. Draft-07 places this table under a narrative section rather than under the SUBSCRIBE_ERROR message definition in section 6.16.

No list of definitions follows this table. Two of the six codes have a stated rule elsewhere in the draft and carry it below; for the other four the Reason text is all there is.

Variants

InternalError = 0

Internal Error

InvalidRange = 1

Invalid Range — section 6.4 requires this code when the requested range cannot be served: for the AbsoluteStart and AbsoluteRange filters when StartGroup is prior to the current group, and when the publisher cannot satisfy the requested start or end, or the end has already been published.

RetryTrackAlias = 2

Retry Track Alias — section 6.16: the SUBSCRIBE_ERROR carries a Track Alias field, and the subscriber should re-issue the SUBSCRIBE with that alias instead. If that alias is itself already in use, the subscriber must close the session with Duplicate Track Alias (SessionErrorCode::DuplicateTrackAlias).

TrackDoesNotExist = 3

Track Does Not Exist

Unauthorized = 4

Unauthorized

Timeout = 5

Timeout

Implementations

impl SubscribeErrorCode

pub const ALL: &[SubscribeErrorCode]

Every SUBSCRIBE_ERROR 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 SubscribeErrorCode, 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 error code.

Trait Implementations

impl Clone for SubscribeErrorCode

fn clone(&self) -> SubscribeErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubscribeErrorCode

impl Debug for SubscribeErrorCode

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

Formats the value using the given formatter.

impl Eq for SubscribeErrorCode

impl PartialEq for SubscribeErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubscribeErrorCode