Struct websocket_codec::UpgradeCodec

pub struct UpgradeCodec { /* fields omitted */ }

Tokio decoder for parsing the server's response to the client's HTTP Connection: Upgrade request.

Methods

impl UpgradeCodec

pub fn new(key: &str) -> Self

Returns a new UpgradeCodec object.

The key parameter provides the string passed to the server via the HTTP Sec-WebSocket-Key header.

Trait Implementations

impl Decoder for UpgradeCodec

type Item = ()

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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 UpgradeCodec

type Item = ()

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors.

fn encode(&mut self, _item: (), _dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.