Struct FrameReadState

pub struct FrameReadState { /* private fields */ }

websocket frame reader

Implementations

impl FrameReadState

pub fn receive<S: Read>( &mut self, stream: &mut S, ) -> Result<(SimplifiedHeader, &[u8]), WsError>

NOTE masked frame has already been unmasked

impl FrameReadState

pub fn with_config(config: FrameConfig) -> Self

construct with config

pub fn is_header_ok(&self) -> bool

check if data in buffer is enough to parse frame header

pub fn get_leading_bits(&self) -> u8

return current frame header bits of buffer

pub fn parse_frame_header(&mut self) -> Result<(usize, usize, usize), WsError>

try to parse frame header in buffer, return (header_len, payload_len, header_len + payload_len)

pub fn consume_frame( &mut self, header_len: usize, payload_len: usize, total_len: usize, ) -> (SimplifiedHeader, Range<usize>)

get a frame and reset state

Trait Implementations

impl Default for FrameReadState

fn default() -> Self

Returns the “default value” for a type.