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.

Implementations

impl MessageCodec[−]

pub fn client() -> Self[−]

Creates a MessageCodec for a client.

Encoded messages are masked.

pub fn server() -> Self[−]

Creates a MessageCodec for a server.

Encoded messages are not masked.

pub fn with_masked_encode(use_mask: bool) -> Self[−]

Creates a MessageCodec while specifying whether to use message masking while encoding.

Trait Implementations

impl Clone for MessageCodec[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> MessageCodec[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

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.

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

Attempts to decode a frame from the provided buffer of bytes.

pub 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.

pub fn framed<T>(self, io: T) -> Framed<T, Self> where
    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<'a> Encoder<&'a Message> for MessageCodec[+]

[+] Show hidden undocumented items

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.

impl Encoder<Message> for MessageCodec[+]

[+] Show hidden undocumented items

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.