Struct Parser 

pub struct Parser;

WebSocket frame parser.

Implementations

impl Parser

pub fn parse( src: &mut BytesMut, server: bool, max_size: usize, ) -> Result<Option<(bool, OpCode, Option<Bytes>)>, ProtocolError>

Parses one WebSocket frame from src.

server selects the expected masking direction: server-side parsing requires masked frames, while client-side parsing rejects them. max_size limits the frame payload size.

Returns the final-fragment flag, opcode, and optional payload when a complete frame is available. Returns None without consuming a partial frame.

pub fn parse_close_payload( payload: &[u8], ) -> Result<Option<CloseReason>, ProtocolError>

Parses a close-frame payload.

Returns None for an empty payload.

Errors

Returns an error for a one-byte payload, an invalid close status code, or a description that is not valid UTF-8.

pub fn write_message<B>( dst: &mut BytePages, pl: B, op: OpCode, fin: bool, mask: bool, ) -> Result<(), ProtocolError>

where BytePage: From<B>,

Encodes a WebSocket frame into dst.

fin controls the final-fragment bit and mask controls whether a new random masking key is applied.

Errors

Returns an error if a control frame is fragmented or has a payload larger than 125 bytes.

pub fn write_close( dst: &mut BytePages, reason: Option<CloseReason>, mask: bool, ) -> Result<(), ProtocolError>

Encodes a final close control frame into dst.

Errors

Returns an error if the close code cannot be sent or the encoded close payload would exceed 125 bytes.

Trait Implementations

impl Debug for Parser

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

Formats the value using the given formatter.