Struct TcpFrameDecoder 

pub struct TcpFrameDecoder { /* private fields */ }

A stateful decoder for RFC 4571 framed TCP packets.

This decoder buffers incoming TCP data and extracts complete framed packets. It handles partial reads gracefully - you can feed it data in any chunk size.

Example

use rtc_shared::tcp_framing::TcpFrameDecoder;

let mut decoder = TcpFrameDecoder::new();

// Simulate receiving data in chunks
let chunk1 = &[0, 5, b'H', b'e']; // Partial: header + 2 bytes
let chunk2 = &[b'l', b'l', b'o']; // Remaining 3 bytes

decoder.extend_from_slice(chunk1);
assert!(decoder.next_packet().is_none()); // Not complete yet

decoder.extend_from_slice(chunk2);
assert_eq!(decoder.next_packet(), Some(b"Hello".to_vec()));

Implementations

impl TcpFrameDecoder

pub fn new() -> Self

Creates a new decoder with an empty buffer.

pub fn with_capacity(capacity: usize) -> Self

Creates a new decoder with pre-allocated buffer capacity.

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

Appends data to the internal buffer.

pub fn next_packet(&mut self) -> Option<Vec<u8>>

Attempts to extract the next complete packet from the buffer.

Returns Some(packet) if a complete packet is available, or None if more data is needed.

The returned packet does not include the 2-byte length header.

pub fn buffered_len(&self) -> usize

Returns the number of buffered bytes.

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 TcpFrameDecoder

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

Formats the value using the given formatter.

impl Default for TcpFrameDecoder

fn default() -> TcpFrameDecoder

Returns the “default value” for a type.