Enum ClientEvent 

#[non_exhaustive]
pub enum ClientEvent<'a> {
    Connected {
        session_present: bool,
        capabilities: ServerCapabilities,
    },
    #[non_exhaustive]
    MessageReceived {
        publish: Publish<'a>,
    },
    PublishAcked {
        packet_id: PacketId,
        reason_code: ReasonCode,
    },
    PublishComplete {
        packet_id: PacketId,
        reason_code: ReasonCode,
    },
    SubscribeAcked {
        packet_id: PacketId,
        reason_codes: &'a [ReasonCode],
    },
    UnsubscribeAcked {
        packet_id: PacketId,
        reason_codes: &'a [ReasonCode],
    },
    Disconnected {
        reason_code: ReasonCode,
    },
    PingResponse,
}

Events produced by the client state machine for the application layer.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Connected

Connection established successfully.

Fields

session_present: bool

Whether the server had existing session state. When false, the I/O driver must call Client::session_lost before draining the session onto the new connection.

capabilities: ServerCapabilities

Server-advertised capabilities from CONNACK properties.

#[non_exhaustive]

MessageReceived

An application message to deliver.

The PUBLISH already passed the protocol checks (QoS 2 duplicate filter, receive quota).

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

publish: Publish<'a>

The decoded PUBLISH, borrowing from the handled packet.

A None topic means an established topic alias; the I/O driver resolves it from its alias table.

PublishAcked

A QoS 1 publish was acknowledged (PUBACK received).

Fields

packet_id: PacketId

Packet identifier of the acknowledged publish.

reason_code: ReasonCode

Reason code from the PUBACK.

PublishComplete

A QoS 2 publish flow completed (PUBCOMP received, or PUBREC with error reason code).

Fields

packet_id: PacketId

Packet identifier of the completed publish.

reason_code: ReasonCode

Reason code from the final acknowledgement.

SubscribeAcked

SUBACK received.

Fields

packet_id: PacketId

Packet identifier of the SUBSCRIBE.

reason_codes: &'a [ReasonCode]

One reason code per requested subscription.

UnsubscribeAcked

UNSUBACK received.

Fields

packet_id: PacketId

Packet identifier of the UNSUBSCRIBE.

reason_codes: &'a [ReasonCode]

One reason code per requested unsubscription.

Disconnected

Server sent DISCONNECT.

Fields

reason_code: ReasonCode

Reason code from the DISCONNECT packet.

PingResponse

PINGRESP received.

Trait Implementations

impl<'a> Debug for ClientEvent<'a>

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

Formats the value using the given formatter.