Enum TransmitEvent 

#[non_exhaustive]
pub enum TransmitEvent {
    Sent {
        packet_id: PacketId,
    },
    PubrelSent {
        packet_id: PacketId,
    },
    SubscribeSent {
        packet_id: PacketId,
    },
    UnsubscribeSent {
        packet_id: PacketId,
    },
    TooLarge {
        packet_id: PacketId,
    },
    Unsupported {
        packet_id: PacketId,
        error: ClientError,
    },
}

An outcome of Client::poll_transmit the caller must act on, reported per packet identifier so the driver can resolve the user-facing future.

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.

Sent

The PUBLISH was written to the output buffer.

Fields

packet_id: PacketId

Packet identifier of the published message.

PubrelSent

A QoS 2 PUBREL was (re)written to the output buffer, under the same packet id as the PUBLISH it completes. Distinct from Sent because it carries no publish-progress update of its own: the publish already reported Sent when the PUBLISH itself went out, and this only keeps the operation’s ack-timeout deadline alive through the PUBREL leg (including across a reconnect).

Fields

packet_id: PacketId

Packet identifier of the publish the PUBREL completes.

SubscribeSent

A SUBSCRIBE was written to the output buffer for the pending group under this packet id.

Fields

packet_id: PacketId

Packet identifier of the SUBSCRIBE.

UnsubscribeSent

An UNSUBSCRIBE was written to the output buffer for the pending group under this packet id.

Fields

packet_id: PacketId

Packet identifier of the UNSUBSCRIBE.

TooLarge

The packet exceeded the server’s Maximum Packet Size and was dropped from the session without being sent (a PUBLISH, or a whole SUBSCRIBE/UNSUBSCRIBE group).

Fields

packet_id: PacketId

Packet identifier of the dropped message or group.

Unsupported

The stored PUBLISH uses a capability the server does not advertise (§3.2.2.3.4/§3.2.2.3.5) and was dropped without being sent. Only reachable when the capabilities shrank across a reconnect.

Fields

packet_id: PacketId

Packet identifier of the dropped message.

error: ClientError

The specific capability violation (QoSNotSupported or RetainNotAvailable).

Trait Implementations

impl Clone for TransmitEvent

fn clone(&self) -> TransmitEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransmitEvent

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

Formats the value using the given formatter.

impl PartialEq for TransmitEvent

fn eq(&self, other: &TransmitEvent) -> 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 Copy for TransmitEvent

impl Eq for TransmitEvent

impl StructuralPartialEq for TransmitEvent