Struct MqttMessage 

pub struct MqttMessage { /* private fields */ }

A message delivered by an MqttSubscriber.

ack acknowledges through the protocol for QoS 1 (PUBACK) and QoS 2 (PUBREC, with the client completing the handshake); QoS 0 deliveries report AckError::Unsupported. MQTT has no negative acknowledgement, so nack(requeue = true) reports AckError::Unsupported as well - unacknowledged messages redeliver when the session resumes - and nack(requeue = false) acknowledges (dropping is the only terminal outcome the protocol offers).

Implementations

impl MqttMessage

pub fn topic(&self) -> &str

The topic this message was published to (the real topic, never a $share filter).

Trait Implementations

impl Debug for MqttMessage

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

Formats the value using the given formatter.

impl IncomingMessage for MqttMessage

fn payload(&self) -> &[u8]

Returns the raw payload of the message.

fn headers(&self) -> &Headers

Returns the headers attached to the message.

async fn ack(self) -> Result<(), AckError>

Acknowledges successful processing. Consumes the message handle.

async fn nack(self, requeue: bool) -> Result<(), AckError>

Negatively acknowledges the message. When requeue is true the broker should redeliver according to its own retry policy; when false it should drop or dead-letter the message.

fn partition_key(&self) -> Option<&[u8]>

Returns the routing key the broker partitioned this message by, or None when the message carries no key.

fn supports_nack_after(&self) -> bool

Reports whether this transport can honor nack_after natively.

fn nack_after( self, delay: Duration, ) -> impl Future<Output = Result<(), AckError>> + Send

where Self: Sized,

Negatively acknowledges the message, asking the broker to redeliver it no sooner than delay from now.