Enum Packet

pub enum Packet {
    Connect(Connect),
    Connack(Connack),
    Publish(Publish),
    Puback(Pid),
    Pubrec(Pid),
    Pubrel(Pid),
    Pubcomp(Pid),
    Subscribe(Subscribe),
    Suback(Suback),
    Unsubscribe(Unsubscribe),
    Unsuback(Pid),
    Pingreq,
    Pingresp,
    Disconnect,
}

MQTT v3.x packet types.

Variants

Connect(Connect)

MQTT 3.1

Connack(Connack)

MQTT 3.2

Publish(Publish)

MQTT 3.3

Puback(Pid)

MQTT 3.4

Pubrec(Pid)

MQTT 3.5

Pubrel(Pid)

MQTT 3.6

Pubcomp(Pid)

MQTT 3.7

Subscribe(Subscribe)

MQTT 3.8

Suback(Suback)

MQTT 3.9

Unsubscribe(Unsubscribe)

MQTT 3.10

Unsuback(Pid)

MQTT 3.11

Pingreq

MQTT 3.12

Pingresp

MQTT 3.13

Disconnect

MQTT 3.14

Implementations

impl Packet

pub fn get_type(&self) -> PacketType

Return the packet type variant.

This can be used for matching, categorising, debuging, etc. Most users will match directly on Packet instead.

pub async fn decode_async<T: AsyncRead + Unpin>( reader: &mut T, ) -> Result<Self, Error>

Asynchronously decode a packet from an async reader.

pub async fn encode_async<T: AsyncWrite + Unpin>( &self, writer: &mut T, ) -> Result<(), Error>

Asynchronously encode the packet to an async writer.

pub fn decode(bytes: &[u8]) -> Result<Option<Self>, Error>

Decode a packet from some bytes. If not enough bytes to decode a packet, it will return Ok(None).

pub fn encode(&self) -> Result<VarBytes, Error>

Encode the packet to a dynamic vector or fixed array.

pub fn encode_len(&self) -> Result<usize, Error>

Return the total length of bytes the packet encoded into.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl From<Connack> for Packet

fn from(p: Connack) -> Self

Converts to this type from the input type.

impl From<Connect> for Packet

fn from(p: Connect) -> Self

Converts to this type from the input type.

impl From<Publish> for Packet

fn from(p: Publish) -> Self

Converts to this type from the input type.

impl From<Suback> for Packet

fn from(p: Suback) -> Self

Converts to this type from the input type.

impl From<Subscribe> for Packet

fn from(p: Subscribe) -> Self

Converts to this type from the input type.

impl From<Unsubscribe> for Packet

fn from(p: Unsubscribe) -> Self

Converts to this type from the input type.

impl PartialEq for Packet

fn eq(&self, other: &Packet) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Packet

impl StructuralPartialEq for Packet