Enum Packet

pub enum Packet {
    Connect(Connect),
    ConnAck(ConnAck),
    Publish(Publish),
    PubAck(PubAck),
    PubRec(PubRec),
    PubRel(PubRel),
    PubComp(PubComp),
    Subscribe(Subscribe),
    SubAck(SubAck),
    UnSubscribe(UnSubscribe),
    UnSubAck(UnSubAck),
    PingReq,
    PingResp,
    Disconnect(Disconnect),
    Auth(Auth),
}

The standard type to manipulate a AsyncRead/AsyncWrite-able MQTT packet. Each packet is an enum value with its own type.

Variants

Connect(Connect)

CONNECT MQTT packet. Opens a connection request.

ConnAck(ConnAck)

CONNACK MQTT packet. Aknowledge a connectio request.

Publish(Publish)

PUBLISH MQTT packet. Delivery a message to or from a server.

PubAck(PubAck)

PUBACK MQTT packet. Ackowledge a QoS 1 or QoS 2 message.

PubRec(PubRec)

PUBREC MQTT packet. Ackowledge a QoS 2 message.

PubRel(PubRel)

PUBREL MQTT packet. Ackowledge a QoS 2 message.

PubComp(PubComp)

PUBCOMP MQTT packet. Ackowledge a QoS 2 message.

Subscribe(Subscribe)

SUBSCRIBE MQTT packet. Subscribe a client to topics.

SubAck(SubAck)

SUBACK MQTT packet. Acknowledge a client SUBSCRIBE packet.

UnSubscribe(UnSubscribe)

UNSUBSCRIBE MQTT packet. Unsubscribe a client from topics.

UnSubAck(UnSubAck)

UNSUBACK MQTT packet. Acknowledge a client UNSUBSCRIBE packet.

PingReq

PINGREQ MQTT packet. Send a ping request.

PingResp

PINGRESP MQTT packet. Respond to a ping request.

Disconnect(Disconnect)

DISCONNECT MQTT packet. Disconnect a connextion and optionally a session.

Auth(Auth)

AUTH MQTT packet. Performs authentication exchanges between clients and server.

Implementations

impl Packet

pub async fn encode<W: AsyncWrite + Unpin>( self, writer: &mut W, ) -> SageResult<usize>

Write the entire Packet to writer, returning the number of bytes written. In case of failure, the operation will return any MQTT-related error, or std::io::Error.

pub async fn decode<R: AsyncRead + Unpin>(reader: &mut R) -> SageResult<Self>

Read a control packet from reader, returning a new Packet. In case of failure, the operation will return any MQTT-related error, or std::io::Error.

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 Display for Packet

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

Formats the value using the given formatter.

impl From<Auth> for Packet

fn from(control: Auth) -> Self

Converts to this type from the input type.

impl From<ConnAck> for Packet

fn from(control: ConnAck) -> Self

Converts to this type from the input type.

impl From<Connect> for Packet

fn from(control: Connect) -> Self

Converts to this type from the input type.

impl From<Disconnect> for Packet

fn from(control: Disconnect) -> Self

Converts to this type from the input type.

impl From<PingReq> for Packet

fn from(_: PingReq) -> Self

Converts to this type from the input type.

impl From<PingResp> for Packet

fn from(_: PingResp) -> Self

Converts to this type from the input type.

impl From<PubAck> for Packet

fn from(control: PubAck) -> Self

Converts to this type from the input type.

impl From<PubComp> for Packet

fn from(control: PubComp) -> Self

Converts to this type from the input type.

impl From<PubRec> for Packet

fn from(control: PubRec) -> Self

Converts to this type from the input type.

impl From<PubRel> for Packet

fn from(control: PubRel) -> Self

Converts to this type from the input type.

impl From<Publish> for Packet

fn from(control: Publish) -> Self

Converts to this type from the input type.

impl From<SubAck> for Packet

fn from(control: SubAck) -> Self

Converts to this type from the input type.

impl From<Subscribe> for Packet

fn from(control: Subscribe) -> Self

Converts to this type from the input type.

impl From<UnSubAck> for Packet

fn from(control: UnSubAck) -> Self

Converts to this type from the input type.

impl From<UnSubscribe> for Packet

fn from(control: UnSubscribe) -> Self

Converts to this type from the input type.