Doc comment about acknowledged messages.

whisperfish · Jul 13, 2020 · 7ad2e31 · 7ad2e31
1 parent 2658326
commit 7ad2e31
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/libsignal-service/src/messagepipe.rs b/libsignal-service/src/messagepipe.rs
@@ -124,6 +124,8 @@ impl<WS: WebSocketService> MessagePipe<WS> {
     }
 
     /// Returns the stream of `Envelope`s
+    ///
+    /// Envelopes yielded are acknowledged.
     pub fn stream(self) -> impl Stream<Item = Result<Envelope, ServiceError>> {
         let (sink, stream) = mpsc::channel(1);