Struct FrameHeader 

pub struct FrameHeader {
    pub frame_type: FrameType,
    pub flags: FrameFlags,
    pub channel_id: u32,
    pub stream_id: u64,
    pub payload_len: u64,
}

A decoded PO frame header.

This is a pure value type — it does not own or reference the payload. After decoding the header, read payload_len bytes from the transport to get the payload.

Fields

frame_type: FrameType

The type of this frame (Data, Handshake, Ping, etc.).

flags: FrameFlags

Processing flags (control, priority, encrypted).

channel_id: u32

Logical channel for application-level multiplexing.

stream_id: u64

Stream identifier for QUIC-like concurrent streams within a channel.

payload_len: u64

Length of the payload that follows this header.

Implementations

impl FrameHeader

pub const fn data(channel_id: u32, payload_len: u64) -> Self

Create a new header for a data frame with default flags.

pub const fn control(frame_type: FrameType) -> Self

Create a new control frame header (e.g., Ping, Pong, Close).

pub const fn with_encrypted(self) -> Self

Set the encrypted flag on this header.

pub const fn with_priority(self) -> Self

Set the priority flag on this header.

pub const fn with_stream(self, stream_id: u64) -> Self

Set the stream ID.

pub const fn encoded_len(&self) -> usize

Calculate the exact number of bytes this header will occupy when encoded.

pub fn encode(&self, buf: &mut [u8]) -> Result<usize, WireError>

Encode this header into the provided buffer.

Returns the number of bytes written.

pub fn decode(buf: &[u8]) -> Result<(Self, usize), WireError>

Decode a header from the provided buffer.

Returns (header, bytes_consumed).

Errors

• WireError::Incomplete if the buffer doesn’t contain a complete header.
• WireError::UnknownFrameType if the type nibble is invalid.

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameHeader

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

Formats the value using the given formatter.

impl Display for FrameHeader

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

Formats the value using the given formatter.

impl PartialEq for FrameHeader

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FrameHeader

impl Eq for FrameHeader

impl StructuralPartialEq for FrameHeader