Enum FrameKind 

pub enum FrameKind {
    Hello,
    Data,
    Error,
    Subscribe,
    Unsubscribe,
    Credit,
    Cursor,
}

What a stream carries.

Variants

Hello

Connection negotiation; header-only.

Data

A transfer: header followed by opaque payload until FIN.

Error

Failure report on the reply half of an exchange; header-only.

Subscribe

Registration of interest in a publisher’s topics; header-only.

Unsubscribe

Withdrawal of a previous SUBSCRIBE; header-only.

Credit

An L2 consumer’s delivery limit for one subscription; header-only.

The credit of decisions/0003 §4.2: a subscription and an absolute delivery limit, so a lost or duplicated frame changes nothing. Only a queue serves it; a path with no queue refuses the stream with UNSUPPORTED.

Cursor

A report about one payload stream; header-only followed by records.

A head frame naming the stream, then (level, offset) records until FIN. Never shares a stream with payload (decisions/0024 §4.4).

Implementations

impl FrameKind

pub const fn to_u8(self) -> u8

The wire code.

pub const fn from_u8(code: u8) -> Option<FrameKind>

Interprets a wire code. Unknown kinds are a protocol violation, not a forward-compatibility hook: a receiver cannot know whether an unknown stream kind carries payload it would have to drain.

pub const fn has_payload(self) -> bool

True if payload bytes follow the header until FIN.

Trait Implementations

impl Clone for FrameKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameKind

impl Debug for FrameKind

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

Formats the value using the given formatter.

impl Display for FrameKind

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

Formats the value using the given formatter.

impl Eq for FrameKind

impl Hash for FrameKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FrameKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameKind