Struct FrameReader 

pub struct FrameReader { /* private fields */ }

Reads length-prefixed frames from a byte buffer.

This struct maintains internal state for incremental parsing, allowing frames to be read from partial data as it arrives.

Implementations

impl FrameReader

pub fn new() -> Self

Creates a new frame reader.

pub fn with_capacity(capacity: usize) -> Self

Creates a new frame reader with the specified initial capacity.

pub fn extend(&mut self, data: &[u8])

Appends data to the internal buffer.

pub fn read_frame(&mut self) -> Result<Option<Vec<u8>>, ControlError>

Attempts to read a complete frame from the buffer.

Returns Ok(Some(data)) if a complete frame is available, Ok(None) if more data is needed, or an error if the frame is invalid.

Errors

Returns an error if the frame size exceeds MAX_FRAME_SIZE.

pub fn buffered_len(&self) -> usize

Returns the number of bytes currently buffered.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

pub fn clear(&mut self)

Clears the internal buffer.

Trait Implementations

impl Debug for FrameReader

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

Formats the value using the given formatter.

impl Default for FrameReader

fn default() -> FrameReader

Returns the “default value” for a type.