Struct Frame 

pub struct Frame {
    pub session_id: u32,
    pub channel_id: u16,
    pub seq: u8,
    pub frame_type: FrameType,
    pub payload: Vec<u8>,
}

Wire representation of a parsed UART protocol frame emitted by crate::FrameParser.

While Frame represents an in-memory parsed frame, encode_frame is the primary zero-allocation serializer for transmitting byte slices over the wire.

Fields

session_id: u32

32-bit session identifier negotiated during handshake.

channel_id: u16

Logical channel identifier (Channel 0 is reserved for control).

seq: u8

8-bit Go-Back-N sequence number.

frame_type: FrameType

Protocol frame type indicator.

payload: Vec<u8>

Raw un-encoded payload bytes.

Implementations

impl Frame

pub fn new( session_id: u32, channel_id: u16, seq: u8, frame_type: FrameType, payload: Vec<u8>, ) -> Result<Self, FrameError>

Creates a new validated protocol frame.

Errors

Returns FrameError::PayloadTooLarge if payload.len() > MAX_PAYLOAD_SIZE.

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

Serializes and encodes this frame with header, header checksum, and trailing CRC-32.

Errors

Returns FrameError::PayloadTooLarge if self.payload.len() > MAX_PAYLOAD_SIZE.

pub fn wire_len(&self) -> usize

Returns the total wire length of this frame in bytes when encoded.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame