Struct websocket_codec::protocol::FrameHeaderCodec

pub struct FrameHeaderCodec;

Tokio codec for the low-level header portion of WebSocket frames. This codec can send and receive FrameHeader structs.

The frame header is a lower level detail of the WebSocket protocol. At the application level, use Message structs and the MessageCodec.

Trait Implementations

impl Decoder for FrameHeaderCodec

type Item = FrameHeader

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<FrameHeader>>

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 FrameHeader> for FrameHeaderCodec

type Error = Error

The type of encoding errors.

pub fn encode(
    &mut self,
    item: &'a FrameHeader,
    dst: &mut BytesMut
) -> Result<()>

Encodes a frame into the buffer provided.

impl Encoder<FrameHeader> for FrameHeaderCodec

type Error = Error

The type of encoding errors.

pub fn encode(&mut self, item: FrameHeader, dst: &mut BytesMut) -> Result<()>

Encodes a frame into the buffer provided.