Struct FrameDecoder 

pub struct FrameDecoder { /* private fields */ }

A streaming decoder that turns a byte stream of DELIMITER-framed data into decoded packets, buffering across arbitrarily sized chunks.

This is the natural way to read COBS packets from a serial/UART link. Feed raw bytes with push; the callback is invoked once per completed frame.

use cobs_codec_rs::framing::{frame_to_vec, FrameDecoder};

let wire = frame_to_vec(&[0x11, 0x00, 0x22]);
let mut rx = FrameDecoder::new();
let mut packets = Vec::new();
// Feed one byte at a time to prove reassembly works across chunks.
for b in &wire {
    rx.push(&[*b], |frame| packets.push(frame.unwrap()));
}
assert_eq!(packets, vec![vec![0x11, 0x00, 0x22]]);

Implementations

impl FrameDecoder

pub fn new() -> Self

Creates a decoder for basic COBS that skips empty frames.

pub fn reduced(self, reduced: bool) -> Self

Decode frames as COBS/R instead of basic COBS.

pub fn skip_empty(self, skip_empty: bool) -> Self

Whether to skip empty frames (from consecutive or leading delimiters) rather than emit empty packets. Defaults to true.

pub fn max_frame_len(self, max_frame_len: usize) -> Self

Bound the number of bytes buffered for a single unterminated frame. When exceeded, the buffer is discarded and the callback receives DecodeError::FrameTooLong. 0 (the default) means unbounded.

pub fn push( &mut self, chunk: &[u8], on_frame: impl FnMut(Result<Vec<u8>, DecodeError>), )

Feeds a chunk of raw bytes, invoking on_frame once per completed frame (Ok with the decoded packet, or Err if a frame failed to decode).

pub fn reset(&mut self)

Discards any buffered partial frame.

Trait Implementations

impl Clone for FrameDecoder

fn clone(&self) -> FrameDecoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameDecoder

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

Formats the value using the given formatter.

impl Default for FrameDecoder

fn default() -> FrameDecoder

Returns the “default value” for a type.