Struct WebSocketCodec 

pub struct WebSocketCodec { /* private fields */ }

WebSocket frame codec for tokio streams

Handles parsing and encoding of WebSocket frames per RFC 6455.

Implementations

impl WebSocketCodec

pub fn new(max_frame_size: usize) -> Self

Create a new codec with specified max frame size.

Uses permissive settings for proxy use:

• Does not enforce masking (handles both masked and unmasked)
• Does not mask outgoing frames

pub fn server() -> Self

Create a new codec for server-side use (receiving client frames)

• Expects masked frames from client
• Does not mask frames to client

pub fn client() -> Self

Create a new codec for client-side use (sending to server)

• Does not expect masked frames from server
• Masks frames to server

pub fn with_max_frame_size(self, size: usize) -> Self

Set maximum frame size

pub fn decode_frame( &self, src: &BytesMut, ) -> Result<Option<(WebSocketFrame, usize)>, Error>

Decode a frame from a byte slice, returning the frame and bytes consumed.

This is a non-mutating version for use with the proxy handler. Returns Ok(None) if more data is needed.

pub fn encode_frame( &self, frame: &WebSocketFrame, masked: bool, ) -> Result<Vec<u8>, Error>

Encode a frame to bytes.

If masked is true, the frame will be masked with a random key.

Trait Implementations

impl Decoder for WebSocketCodec

type Item = WebSocketFrame

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Encoder<WebSocketFrame> for WebSocketCodec

type Error = Error

The type of encoding errors.

fn encode( &mut self, frame: WebSocketFrame, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.