Struct actix_http::ws::Codec

pub struct Codec { /* private fields */ }

Available on crate feature ws only.

WebSocket protocol codec.

Implementations

impl Codec

pub const 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 64KiB.

pub fn client_mode(self) -> Self

Set decoder to client mode.

By default decoder works in server mode.

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

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Message> for Codec

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.