diff --git a/rumqttc/src/lib.rs b/rumqttc/src/lib.rs index 75af3645..2a6ead18 100644 --- a/rumqttc/src/lib.rs +++ b/rumqttc/src/lib.rs @@ -258,6 +258,10 @@ impl Future for AckPromise { } impl AckPromise { + /// Blocks on the current thread and waits till the packet is acknowledged by the broker. + /// + /// Returns [`PromiseError::Disconnected`] if the [`EventLoop`] was dropped(usually), + /// [`PromiseError::Rejected`] if the packet acknowledged but not accepted. pub fn blocking_wait(self) -> Result { self.rx .blocking_recv()