Struct UnsubscribeBuilder

pub struct UnsubscribeBuilder {
    cmd_tx: Sender<Command>,
    filters: Vec<TopicFilterBuf>,
}

Expand description

Builder for unsubscribing from one or more topic filters.

Obtained via MqttClient::unsubscribe.

Call send to get an UnsubscribeFuture that can be awaited for UNSUBACK, or converted to a QueuedUnsubscribeFuture via UnsubscribeFuture::queued.

Fields§

§cmd_tx: Sender<Command>§filters: Vec<TopicFilterBuf>

Implementations§

§

impl UnsubscribeBuilder

pub(crate) fn new(cmd_tx: Sender<Command>, filter: TopicFilterBuf) -> Self

pub fn and(self, filter: TopicFilterBuf) -> Self

Adds an additional filter to this unsubscribe batch.

pub fn send(self) -> UnsubscribeFuture ⓘ

Returns an UnsubscribeFuture that drives the UNSUBSCRIBE to completion.

No work is done until the future is first polled. Await the future to wait for UNSUBACK, or call UnsubscribeFuture::queued to convert it into a QueuedUnsubscribeFuture that resolves as soon as the unsubscribe is recorded locally.

Auto Trait Implementations§

§

impl UnwindSafe for UnsubscribeBuilder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§