Struct actix_http::ws::Codec

pub struct Codec { /* fields omitted */ }

WebSockets protocol codec

Methods

impl Codec

pub fn new() -> Codec

Create new websocket frames decoder

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

Set max frame size

By default max size is set to 64kb

pub fn client_mode(self) -> Self

Set decoder to client mode.

By default decoder works in server mode.

Trait Implementations

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(
    &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
    Self: Encoder,
    T: AsyncRead + AsyncWrite, 

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 for Codec

type Item = Message

The type of items consumed by the Encoder

type Error = ProtocolError

The type of encoding errors.

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

Encodes a frame into the buffer provided.