doc: comment on blocking_wait

bytebeamio · Oct 2, 2024 · 79d5ff8 · 79d5ff8
1 parent 979cb8f
commit 79d5ff8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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<Pkid, PromiseError> {
         self.rx
             .blocking_recv()