Struct FrameDecoder 

pub struct FrameDecoder { /* private fields */ }

Streaming frame decoder. Buffers raw bytes across multiple Read calls so frames split across network reads (or read with WouldBlock between header / payload) decode correctly on the next call.

Implementations

impl FrameDecoder

pub fn new() -> FrameDecoder

pub fn decode_frame<R>( &mut self, reader: &mut R, ) -> Result<Option<FrameHeader>, Error>

where R: Read,

Decode one frame header. Returns Ok(Some(header)) on success, Ok(None) if no frame is yet available, or Err on a fatal I/O failure. WouldBlock / TimedOut from the underlying stream are normalised to WouldBlock so callers can retry.

pub fn take_payload(&mut self, header: &FrameHeader) -> Vec<u8>

Take the payload of the most recently decoded frame. Resets the buffer so the next decode_frame starts fresh.

pub fn take_mask(&mut self) -> [u8; 4]

Take the 4-byte mask key preceding the payload of the current frame.

Trait Implementations

impl Default for FrameDecoder

fn default() -> FrameDecoder

Returns the “default value” for a type.