Struct PublishFuture 

pub struct PublishFuture {
    dispatch: DispatchState,
    queued_rx: Receiver<Result<(), Error>>,
    completion_rx: Receiver<Result<ReasonCode, Error>>,
    progress_rx: Receiver<PublishProgress>,
}

A pending publish operation.

Awaiting this future drives the publish to broker acknowledgement:

• QoS::AtMostOnce resolves once the bytes have been written.
• QoS::AtLeastOnce resolves on PUBACK.
• QoS::ExactlyOnce resolves on PUBCOMP.

To wait only for the publish to be queued (persisted to the outbox for QoS >= 1, or accepted by the event loop for QoS 0) call queued before awaiting.

Fields

dispatch: DispatchState

queued_rx: Receiver<Result<(), Error>>

completion_rx: Receiver<Result<ReasonCode, Error>>

progress_rx: Receiver<PublishProgress>

Implementations

impl PublishFuture

pub(super) fn new( cmd_tx: Sender<Command>, topic: TopicBuf, payload: Vec<u8>, qos: QoS, retain: bool, properties: PublishOptions, ) -> Self

pub fn progress(&self) -> PublishProgress

Returns the current observable progress.

May still be PublishProgress::Pending if the future has not been polled yet.

pub fn queued(self) -> QueuedPublishFuture

Reduces this future to only the queued half of the publish.

The returned future resolves as soon as the message has been stored in the outbox (QoS >= 1) or accepted by the event loop (QoS 0). For QoS 0 while offline the message is sent best-effort on the next connection and may be silently dropped if the client shuts down without reconnecting. The broker acknowledgement is abandoned.

Trait Implementations

impl Future for PublishFuture

type Output = Result<ReasonCode, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.