Struct Parser 

pub struct Parser;

Available on crate feature ws only.

A struct representing a WebSocket frame.

Implementations

impl Parser

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

Parse the input stream into a frame.

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

👎Deprecated since 3.13.5:

Use Parser::try_parse_close_payload instead.

Parse the payload of a close frame.

This method preserves the historical behavior of accepting unknown status codes and replacing invalid UTF-8 in the reason. Use Parser::try_parse_close_payload when the payload must be validated.

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

Parse and validate the payload of a close frame.

Validation

A close payload is either empty or contains a two-byte status code followed by an optional UTF-8 reason. This follows RFC 6455 §5.5.1, with status code rules from RFC 6455 §7.4 and UTF-8 error handling from RFC 6455 §8.1.

pub fn write_message<B: AsRef<[u8]>>( dst: &mut BytesMut, pl: B, op: OpCode, fin: bool, mask: bool, )

Generate binary representation

pub fn write_close(dst: &mut BytesMut, reason: Option<CloseReason>, mask: bool)

Create a new Close control frame.

Trait Implementations

impl Debug for Parser

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

Formats the value using the given formatter.