Enum StreamResetErrorCode 

#[repr(u64)]
pub enum StreamResetErrorCode {
    InternalError = 0,
    Cancelled = 1,
    DeliveryTimeout = 2,
    SessionClosed = 3,
    GoingAway = 4,
    TooFarBehind = 5,
    UnknownObjectStatus = 6,
    ExpiredAuthToken = 7,
    ExcessiveLoad = 9,
    MalformedTrack = 18,
}

Stream reset error codes (draft-19 Section 15.11.4).

Section 3.3.4 says the application SHOULD use a relevant code from this registry when resetting, or sending STOP_SENDING on, any stream — data streams and request streams alike. The per-code definitions are in that same section.

Drafts 14 through 17, draft-17 Section 14.5.4 among them, titled this registry “Data Stream Reset Error Codes” and this crate names those drafts’ enums DataStreamResetErrorCode. Draft-18 renamed it and widened it beyond data streams; draft-19 keeps both the name and the wider scope, so this enum takes that title.

The registry also reserves the code points 0x7f * N + 0x9D for greasing (draft-19 Section 14). That is a range rather than an assignment, so it has no variant here and from_u64 reports it as unknown.

Variants

InternalError = 0

INTERNAL_ERROR — An implementation specific error.

Cancelled = 1

CANCELLED — The stream was cancelled by either endpoint. For Subscriptions, PUBLISH_DONE (Section 10.11) may have a more detailed status code.

DeliveryTimeout = 2

DELIVERY_TIMEOUT — A delivery timeout (Section 8) was exceeded for this stream.

SessionClosed = 3

SESSION_CLOSED — The session is being closed.

GoingAway = 4

GOING_AWAY — The endpoint is rejecting this request because it has sent or received a GOAWAY.

TooFarBehind = 5

TOO_FAR_BEHIND — The corresponding subscription has exceeded the publisher’s resource limits and is being terminated (see Section 8).

UnknownObjectStatus = 6

UNKNOWN_OBJECT_STATUS — In response to a FETCH, the publisher is unable to determine the status of the next Object in the requested range.

ExpiredAuthToken = 7

EXPIRED_AUTH_TOKEN — The authorization token for the request has expired.

ExcessiveLoad = 9

EXCESSIVE_LOAD — The endpoint is overloaded and is resetting this stream.

MalformedTrack = 18

MALFORMED_TRACK — A relay publisher detected that the track was malformed (see Section 2.4.2).

Implementations

impl StreamResetErrorCode

pub const ALL: &[StreamResetErrorCode]

Every Stream Reset Error Code draft-19 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 — that this is the set from_u64 answers to, and that none of it lands in the range the draft reserves for greasing.

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

Convert a raw u64 to a StreamResetErrorCode, if the draft assigns that code point.

Returns None for any unassigned value, including the greasing range, so that a peer sending a code this draft does not define cannot break decoding.

pub fn as_u64(self) -> u64

Return the raw u64 value of this error code.

Trait Implementations

impl Clone for StreamResetErrorCode

fn clone(&self) -> StreamResetErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamResetErrorCode

impl Debug for StreamResetErrorCode

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

Formats the value using the given formatter.

impl Eq for StreamResetErrorCode

impl PartialEq for StreamResetErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamResetErrorCode