ClientShutdownHandle

Struct ClientShutdownHandle 

Source
pub struct ClientShutdownHandle { /* private fields */ }
Expand description

An owned handle that can be used to disconnect and shutdown an MQTT client’s transceiver task and obtain its ShutdownStatus.

Should this value be dropped without calling ClientShutdownHandle::disconnect() beforehand, the client’s transceiver task will be detached.

Implementations§

Source§

impl ClientShutdownHandle

Source

pub async fn disconnect(self) -> Result<ShutdownStatus, JoinError>

Enqueues a disconnect command, causing the transceiver task to attempt to disconnect gracefully and shutdown. Unlike Client::disconnect(), this function will wait for the transceiver task to complete before returning, and also returns a ShutdownStatus, which can be used to know whether the client managed to disconnect gracefully or not.

Pending publish packets may not be sent, and existing subscriptions will be closed.

Auto Trait Implementations§

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.

Source§

impl<T, U> Into<U> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.