Struct websocket_codec::MessageCodec

[+] Show declaration

pub struct MessageCodec { /* fields omitted */ }

[−] Expand description

Tokio codec for WebSocket messages. This codec can send and receive Message structs.

Methods

impl MessageCodec[−]

pub fn new() -> Self[−]

Creates a MessageCodec.

Trait Implementations

impl Decoder for MessageCodec[+]

[+] Show hidden undocumented items

type Item = Message

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Message>>[−]

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 MessageCodec[+]

[+] Show hidden undocumented items

type Item = Message

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors.

fn encode(&mut self, item: Message, dst: &mut BytesMut) -> Result<()>[−]

Encodes a frame into the buffer provided.