Struct FrameReader 

pub struct FrameReader<'a> { /* private fields */ }

Reads length-prefixed frames from a byte stream.

Yields individual message payloads that can be decoded with BitReader.

Example

use vexil_runtime::{BitReader, FrameReader};

let stream: &[u8] = &[
    4, 0x2A, 0x00, 0x00, 0x00,  // frame 1: len=4, u32(42) LE
    6, 0x05, 0x68, 0x65, 0x6C, 0x6C, 0x6F, // frame 2: len=6, string "hello"
];
let mut fr = FrameReader::new(stream);

let frame1 = fr.read_frame().unwrap().unwrap();
let mut r = BitReader::new(frame1);
assert_eq!(r.read_u32().unwrap(), 42);

let frame2 = fr.read_frame().unwrap().unwrap();
let mut r = BitReader::new(frame2);
assert_eq!(r.read_string().unwrap(), "hello");

assert!(fr.read_frame().is_none()); // EOF

Implementations

impl<'a> FrameReader<'a>

pub fn new(data: &'a [u8]) -> Self

Create a new frame reader over the given byte stream.

pub fn read_frame(&mut self) -> Option<Result<&'a [u8], DecodeError>>

Read the next frame. Returns the payload bytes, or None at EOF.

pub fn is_empty(&self) -> bool

Returns true if there are no more frames.

pub fn remaining(&self) -> &'a [u8]

Returns remaining bytes (partial frame or trailing data).