Struct mqtt_v5::codec::MqttCodec

pub struct MqttCodec { /* fields omitted */ }

Methods

impl MqttCodec

pub fn new() -> Self

pub fn decode(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Packet>, DecodeError>

pub fn encode(
    &mut self,
    packet: Packet,
    bytes: &mut BytesMut
) -> Result<(), DecodeError>

Trait Implementations

impl Decoder for MqttCodec

type Error = DecodeError

The type of unrecoverable frame decoding errors.

type Item = Packet

The type of decoded frames.

fn decode(
    &mut self,
    buf: &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
    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 MqttCodec

type Error = DecodeError

The type of encoding errors.

type Item = Packet

The type of items consumed by the Encoder

fn encode(
    &mut self,
    packet: Self::Item,
    bytes: &mut BytesMut
) -> Result<(), DecodeError>

Encodes a frame into the buffer provided.