Enum mqttrust_core::Packet

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

Base enum for all MQTT packet types.

This is the main type you’ll be interacting with, as an output of decode_slice() and an input of encode(). Most variants can be constructed directly without using methods.

// Simplest form
let pkt = Packet::Connack(Connack { session_present: false,
                                    code: ConnectReturnCode::Accepted });
// Using `Into` trait
let publish = Publish { dup: false,
                        qos: QoS::AtMostOnce,
                        retain: false,
                        pid: None,
                        topic_name: "to/pic",
                        payload: b"payload" };
let pkt: Packet = publish.into();
// Identifyer-only packets
let pkt = Packet::Puback(Pid::try_from(42).unwrap());

Variants

Connect(Connect<'a>)

MQTT 3.1

Tuple Fields of Connect

0: Connect<'a>

Connack(Connack)

MQTT 3.2

Tuple Fields of Connack

0: Connack

Publish(Publish<'a>)

MQTT 3.3

Tuple Fields of Publish

0: Publish<'a>

Puback(Pid)

MQTT 3.4

Tuple Fields of Puback

0: Pid

Pubrec(Pid)

MQTT 3.5

Tuple Fields of Pubrec

0: Pid

Pubrel(Pid)

MQTT 3.6

Tuple Fields of Pubrel

0: Pid

Pubcomp(Pid)

MQTT 3.7

Tuple Fields of Pubcomp

0: Pid

Subscribe(Subscribe<'a>)

MQTT 3.8

Tuple Fields of Subscribe

0: Subscribe<'a>

Suback(Suback<'a>)

MQTT 3.9

Tuple Fields of Suback

0: Suback<'a>

Unsubscribe(Unsubscribe<'a>)

MQTT 3.10

Tuple Fields of Unsubscribe

0: Unsubscribe<'a>

Unsuback(Pid)

MQTT 3.11

Tuple Fields of Unsuback

0: Pid

Pingreq

MQTT 3.12

Pingresp

MQTT 3.13

Disconnect

MQTT 3.14

Implementations

impl<'a> Packet<'a>

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 fn len(&self) -> usize

Trait Implementations

impl<'a> Clone for Packet<'a>

pub fn clone(&self) -> Packet<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Packet<'a>

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

Formats the value using the given formatter.

impl<'a> From<Connack> for Packet<'a>

pub fn from(p: Connack) -> Packet<'a>

Performs the conversion.

impl<'a> From<Connect<'a>> for Packet<'a>

pub fn from(p: Connect<'a>) -> Packet<'a>

Performs the conversion.

impl<'a> From<Publish<'a>> for Packet<'a>

pub fn from(p: Publish<'a>) -> Packet<'a>

Performs the conversion.

impl<'a> From<Suback<'a>> for Packet<'a>

pub fn from(p: Suback<'a>) -> Packet<'a>

Performs the conversion.

impl<'a> From<Subscribe<'a>> for Packet<'a>

pub fn from(p: Subscribe<'a>) -> Packet<'a>

Performs the conversion.

impl<'a> From<Unsubscribe<'a>> for Packet<'a>

pub fn from(p: Unsubscribe<'a>) -> Packet<'a>

Performs the conversion.

impl<'a> PartialEq<Packet<'a>> for Packet<'a>

pub fn eq(&self, other: &Packet<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Packet<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Packet<'a>