Struct soketto::base::Codec

pub struct Codec { /* private fields */ }

Codec for encoding/decoding websocket base frames.

Implementations

impl Codec

pub fn new() -> Self

Create a new base frame codec.

The codec will support decoding payload lengths up to 256 MiB (use set_max_data_size to change this value).

pub fn max_data_size(&self) -> usize

Get the configured maximum payload length.

pub fn set_max_data_size(&mut self, size: usize) -> &mut Self

Limit the maximum size of payload data to size bytes.

pub fn reserved_bits(&self) -> (bool, bool, bool)

The reserved bits currently configured.

pub fn add_reserved_bits(&mut self, bits: (bool, bool, bool)) -> &mut Self

Add to the reserved bits in use.

pub fn clear_reserved_bits(&mut self)

Reset the reserved bits.

pub fn decode_header(
    &self,
    bytes: &[u8]
) -> Result<Parsing<Header, usize>, Error>

Decode a websocket frame header.

pub fn encode_header(&mut self, header: &Header) -> &[u8]

Encode a websocket frame header.

pub fn apply_mask(header: &Header, data: &mut [u8])

Use the given header’s mask and apply it to the data.

Trait Implementations

impl Clone for Codec

fn clone(&self) -> Codec

Returns a copy 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 Default for Codec

fn default() -> Self

Returns the “default value” for a type.