Struct FrameBuffer 

pub struct FrameBuffer { /* private fields */ }

Buffer for accumulating incoming bytes and extracting complete frames.

Uses a state machine to handle partial reads efficiently. All data is stored in a single BytesMut buffer to minimize allocations.

Implementations

impl FrameBuffer

pub fn new() -> Self

Create a new frame buffer with default settings.

Default capacity: 64KB, max payload: 1GB.

pub fn with_max_payload(max_payload_size: u32) -> Self

Create a new frame buffer with custom max payload size.

pub fn with_capacity_and_max_payload( capacity: usize, max_payload_size: u32, ) -> Self

Create a new frame buffer with custom capacity and max payload.

pub fn push(&mut self, data: &[u8]) -> Result<Vec<Frame>>

Push data into the buffer and extract all complete frames.

This is the main API for processing incoming data from the socket. Returns a vector of complete frames. If data is fragmented, partial data is buffered internally for the next push.

Arguments

• data - Raw bytes from socket read

Returns

Vector of complete frames (may be empty if still waiting for data).

Errors

Returns error if payload exceeds max_payload_size.

pub fn try_extract(&mut self) -> Option<Frame>

👎Deprecated: Use push() instead for proper multi-frame handling

Legacy method - try to extract a single frame.

Prefer using push() which handles multiple frames efficiently.

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

Append data to the buffer without extracting frames.

Prefer using push() which does extend + extract in one call.

pub fn len(&self) -> usize

Get the number of buffered bytes.

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

pub fn clear(&mut self)

Clear the buffer and reset state.

Trait Implementations

impl Default for FrameBuffer

fn default() -> Self

Returns the “default value” for a type.