Enum SubscribeErrorCode 

#[repr(u64)]
pub enum SubscribeErrorCode {
    InternalError = 0,
    Unauthorized = 1,
    Timeout = 2,
    NotSupported = 3,
    TrackDoesNotExist = 4,
    InvalidRange = 5,
    RetryTrackAlias = 6,
    MalformedAuthToken = 16,
    UnknownAuthTokenAlias = 17,
    ExpiredAuthToken = 18,
}

SUBSCRIBE_ERROR codes, from the table in draft-11 section 8.9.

The draft assigns 0x0 through 0x6 and then 0x10 through 0x12; 0x7 through 0xF are not assigned.

Variants

InternalError = 0

Internal Error — an implementation specific or generic error occurred.

Unauthorized = 1

Unauthorized — the subscriber is not authorized to subscribe to the given track.

Timeout = 2

Timeout — the subscription could not be completed before an implementation specific timeout. For example, a relay could not establish an upstream subscription within the timeout.

NotSupported = 3

Not Supported — the endpoint does not support the SUBSCRIBE method.

TrackDoesNotExist = 4

Track Does Not Exist — the requested track is not available at the publisher.

InvalidRange = 5

Invalid Range — the end of the SUBSCRIBE range is earlier than the beginning, or the end of the range has already been published.

RetryTrackAlias = 6

Retry Track Alias — the publisher requires the subscriber to use the given Track Alias when subscribing. The alias to retry with is carried in the Track Alias field of the SUBSCRIBE_ERROR message.

MalformedAuthToken = 16

Malformed Auth Token — invalid Auth Token serialization during registration. See draft-11 section 8.2.1.1.

UnknownAuthTokenAlias = 17

Unknown Auth Token Alias — the Authorization Token refers to an alias that is not registered. See draft-11 section 8.2.1.1.

ExpiredAuthToken = 18

Expired Auth Token — the authorization token has expired. See draft-11 section 8.2.1.1.

Implementations

impl SubscribeErrorCode

pub const ALL: &[SubscribeErrorCode]

Every SUBSCRIBE_ERROR code draft-11 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 valid.

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