Enum mqttrs::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,
}

Base enum for all MQTT packet types.

This is the main type you'll be interacting with, as an output of decode() 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,
                        qospid: QosPid::AtMostOnce,
                        retain: false,
                        topic_name: "to/pic".into(),
                        payload: "payload".into() };
let pkt: Packet = publish.into();
// Identifyer-only packets
let pkt = Packet::Puback(Pid::try_from(42).unwrap());

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

Methods

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.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy 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

Performs the conversion.

impl From<Connect> for Packet

fn from(p: Connect) -> Self

Performs the conversion.

impl From<Publish> for Packet

fn from(p: Publish) -> Self

Performs the conversion.

impl From<Suback> for Packet

fn from(p: Suback) -> Self

Performs the conversion.

impl From<Subscribe> for Packet

fn from(p: Subscribe) -> Self

Performs the conversion.

impl From<Unsubscribe> for Packet

fn from(p: Unsubscribe) -> Self

Performs the conversion.

impl PartialEq<Packet> for Packet

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

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

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

This method tests for !=.

impl StructuralPartialEq for Packet