Struct Codec 

pub struct Codec { /* private fields */ }

Encoder and decoder for WebSocket frames.

Implementations

impl Codec

pub fn new() -> Codec

Creates a codec in server mode with a 64 KiB frame-size limit.

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

Sets the maximum accepted frame payload size.

The default is 64 KiB.

pub fn set_client_mode(self) -> Self

Configures the codec for client-side masking rules.

Client mode masks encoded frames and rejects masked incoming frames. By default, the codec uses server-side masking rules.

pub fn is_closed(&self) -> bool

Returns true after this codec has encoded a close message.

pub fn encode_page( &self, page: BytePage, dst: &mut BytePages, ) -> Result<(), ProtocolError>

Encodes page as a final binary frame.

Errors

Returns ProtocolError::Closed if a close message has already been encoded, or ProtocolError::ContinuationStarted if a fragmented message is in progress.

Trait Implementations

impl Clone for Codec

fn clone(&self) -> Codec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Codec

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

Formats the value using the given formatter.

impl Decoder for Codec

type Item = Frame

The type of decoded frames.

type Error = ProtocolError

The type of unrecoverable frame decoding errors.

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

Attempts to decode a frame from the buffered input.

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

Attempts to decode a frame once the transport reached a clean EOF.

impl Default for Codec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder for Codec

type Item = Message

The type of frames consumed by the encoder.

type Error = ProtocolError

The type of encoding errors.

fn encode(&self, item: Message, dst: &mut BytePages) -> Result<(), Self::Error>

Encodes a frame and appends it to dst.