Struct FrameReader 

pub struct FrameReader { /* private fields */ }

WebSocket frame reader — parses wire bytes into Messages.

Handles wire frame parsing, fragment assembly, control frame interleaving, masking, and UTF-8 validation. The user sees complete Message values — never raw frames or continuations.

Usage

use nexus_net::ws::{FrameReader, Role, Message};

let mut reader = FrameReader::builder()
    .role(Role::Client)
    .buffer_capacity(65_536)
    .build();

// Feed wire bytes
reader.read(&[0x81, 0x05, 0x48, 0x65, 0x6C, 0x6C, 0x6F]).unwrap();

// Parse messages
match reader.next().unwrap().unwrap() {
    Message::Text(s) => assert_eq!(s, "Hello"),
    _ => panic!("expected text"),
}

Implementations

impl FrameReader

pub fn builder() -> FrameReaderBuilder

Create a builder.

pub fn read(&mut self, src: &[u8]) -> Result<(), ReadError>

Buffer wire bytes from a source.

pub fn read_from<R>(&mut self, src: &mut R) -> Result<usize, Error>

where R: Read,

Read bytes from a source directly into the internal buffer.

Convenience for spare() + filled(). Returns bytes read, or 0 on EOF. Returns Err if the buffer is full after compaction (indicates the buffer is undersized for the current message).

let n = reader.read_from(&mut socket)?;

pub fn spare(&mut self) -> &mut [u8]

Writable region for direct socket reads.

pub fn filled(&mut self, n: usize)

Commit bytes written into spare().

pub fn compact(&mut self)

Reclaim consumed buffer space by moving unconsumed data to the front.

Call when spare() is empty but there’s still data to read. This is O(n) in the amount of unconsumed data.

pub fn should_compact(&self) -> bool

Whether the ReadBuf should be compacted based on the configured threshold.

Returns true when at least one byte has been consumed, consumed bytes meet or exceed the threshold set by FrameReaderBuilder::compact_at, and there is unconsumed data to preserve. Default threshold is 50% of buffer capacity.

pub fn next(&mut self) -> Result<Option<Message<'_>>, ProtocolError>

Parse the next complete message.

pub fn poll(&mut self) -> Result<bool, ProtocolError>

Advance the parser without constructing a Message. Returns true if the next call to next() will return a message.

pub fn remaining(&self) -> usize

Bytes of buffer space remaining.

pub fn buffered(&self) -> usize

Bytes of unconsumed data in the buffer.

pub fn reset(&mut self)

Reset all state.

Trait Implementations

impl Debug for FrameReader

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

Formats the value using the given formatter.

impl ParserSink for FrameReader

Lets a WireStream feed bytes directly into the FrameReader’s spare region — one fewer copy than going through a slice intermediary.

fn spare(&mut self) -> &mut [u8]

Writable region where new bytes go.

fn filled(&mut self, n: usize)

Commit n bytes written into spare().