Enum MqttCodec

Source
pub enum MqttCodec {
    V3(Codec),
    V5(Codec),
    Version(VersionCodec),
}
Expand description

Main MQTT protocol codec implementation

Handles version negotiation and provides unified interface for:

  • MQTT v3.1.1
  • MQTT v5.0
  • Protocol version detection

Variants§

§

V3(Codec)

MQTT v3.1.1 codec

§

V5(Codec)

MQTT v5.0 codec

§

Version(VersionCodec)

Protocol version detection codec (used during initial handshake)

Trait Implementations§

Source§

impl Debug for MqttCodec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Decoder for MqttCodec

Source§

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

Decodes network bytes into MQTT packets

Returns tuple containing:

  • Decoded packet
  • Number of bytes consumed from input buffer
§Example
use bytes::{BytesMut, BufMut};
use rmqtt_codec::{MqttCodec, v3};
use tokio_util::codec::Decoder;

let mut codec = MqttCodec::V3(v3::Codec::new(1024*1024));
let mut buffer = BytesMut::new();
buffer.put_slice(b"\x30\x00"); // Publish packet
let packet = codec.decode(&mut buffer);
Source§

type Item = (MqttPacket, u32)

The type of decoded frames.
Source§

type Error = DecodeError

The type of unrecoverable frame decoding errors. Read more
Source§

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. Read more
Source§

fn framed<T>(self, io: T) -> Framed<T, Self>
where T: AsyncRead + AsyncWrite, Self: Sized,

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. Read more
Source§

impl Encoder<MqttPacket> for MqttCodec

Source§

fn encode( &mut self, item: MqttPacket, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes MQTT packets according to active protocol version

§Example
use bytes::BytesMut;
use rmqtt_codec::{MqttCodec, MqttPacket, v3};
use tokio_util::codec::Encoder;

let mut codec = MqttCodec::V3(v3::Codec::new(1024*1024));
let mut buffer = BytesMut::new();
let packet = MqttPacket::V3(v3::Packet::PingRequest);
codec.encode(packet, &mut buffer).unwrap();
Source§

type Error = EncodeError

The type of encoding errors. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.