Struct ws_tool::codec::FrameReadState

pub struct FrameReadState { /* private fields */ }

websocket read state

Implementations

impl FrameReadState

pub fn receive<S: Read>(&mut self, stream: &mut S) -> Result<OwnedFrame, WsError>

NOTE masked frame has already been unmasked

impl FrameReadState

pub fn with_remain(config: FrameConfig, read_data: BytesMut) -> Self

construct with config and bytes remaining in handshake

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, WsError>

try to parse frame header in buffer, return expected payload

pub fn consume_frame(&mut self, len: usize) -> OwnedFrame

get a frame and reset state

pub fn check_frame( &mut self, unmasked_frame: OwnedFrame ) -> Result<Option<OwnedFrame>, WsError>

perform protocol checking after receiving a frame

Trait Implementations

impl Clone for FrameReadState

fn clone(&self) -> FrameReadState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameReadState

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

Formats the value using the given formatter.

impl Default for FrameReadState

fn default() -> Self

Returns the “default value” for a type.