Struct SubscribeBuilder 

pub struct SubscribeBuilder {
    cmd_tx: Sender<Command>,
    subscriptions: Vec<Subscription>,
    subscription_id: Option<u32>,
}

Builder for subscribing to one or more topic filters.

Obtained via MqttClient::subscribe.

Call send to get a SubscribeFuture that can be awaited for SUBACK, or converted to a QueuedSubscribeFuture via SubscribeFuture::queued to resolve as soon as the subscription is recorded locally.

Fields

cmd_tx: Sender<Command>

subscriptions: Vec<Subscription>

subscription_id: Option<u32>

Implementations

impl SubscribeBuilder

pub(crate) fn new(cmd_tx: Sender<Command>, subscription: Subscription) -> Self

pub fn and(self, subscription: Subscription) -> Self

Adds an additional subscription to this batch.

All subscriptions in the batch are sent in a single SUBSCRIBE packet.

pub const fn subscription_id(self, id: u32) -> Self

Assigns a Subscription Identifier (v5, property 0x0B).

The broker echoes this identifier in PUBLISH packets that match any filter in this batch.

pub fn send(self) -> SubscribeFuture

Returns a SubscribeFuture that drives the SUBSCRIBE to completion.

No work is done until the future is first polled. A permit on the command channel is reserved before the Command is built, so memory is only allocated once back-pressure is released.

Await the future to wait for SUBACK, or call SubscribeFuture::queued to convert it into a QueuedSubscribeFuture that resolves as soon as the subscription is recorded locally.