Struct StreamFrame 

pub struct StreamFrame {
    pub stream_id: StreamId,
    pub sequence: u64,
    pub data: Vec<u8>,
    pub flags: u8,
    pub timestamp: u64,
}

A framed unit of data for one logical stream.

Wire format (little-endian)

[stream_id: u32 LE][sequence_num: u64 LE][payload_len: u32 LE][flags: u8][timestamp: u64 LE][payload...]

Fields

stream_id: StreamId

Which stream this frame belongs to.

sequence: u64

Monotonically increasing per-stream sequence number.

data: Vec<u8>

Payload bytes.

flags: u8

Control flags: FLAG_FIN, FLAG_RST, FLAG_SYN.

timestamp: u64

Wall-clock timestamp at the time the frame was created (caller-supplied).

Implementations

impl StreamFrame

pub fn is_fin(&self) -> bool

Returns true if the FIN flag is set (legacy raw-u8 form).

pub fn is_rst(&self) -> bool

Returns true if the RST flag is set (legacy raw-u8 form).

pub fn is_syn(&self) -> bool

Returns true if the SYN flag is set (legacy raw-u8 form).

pub fn is_control(&self) -> bool

Returns true if this is a pure control frame (no payload bytes matter).

pub fn encode(&self) -> Vec<u8>

Encode the frame into a Vec<u8> using the fixed wire format.

Wire layout (all little-endian): stream_id(4) + sequence_num(8) + payload_len(4) + flags(1) + timestamp(8) + payload

Total header: 25 bytes.

pub fn decode(data: &[u8]) -> Result<Self, MuxError>

Decode a frame from a byte slice produced by StreamFrame::encode.

Errors

Returns MuxError::FrameTooLarge if data is shorter than the minimum header size or shorter than the declared payload length.

Trait Implementations

impl Clone for StreamFrame

fn clone(&self) -> StreamFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamFrame

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

Formats the value using the given formatter.