Clarify poll_message docs

Closes #975
2023-01-01 20:33:06 -05:00 · 2023-01-01 20:33:06 -05:00 · 0c056148d0
commit 0c056148d0
parent 8ab8f1a555
1 changed files with 3 additions and 0 deletions
--- a/tokio-postgres/src/connection.rs
+++ b/tokio-postgres/src/connection.rs
@ -302,6 +302,9 @@ where
    ///
    /// The server can send notices as well as notifications asynchronously to the client. Applications that wish to
    /// examine those messages should use this method to drive the connection rather than its `Future` implementation.
+    ///
+    /// Return values of `None` or `Some(Err(_))` are "terminal"; callers should not invoke this method again after
+    /// receiving one of those values.
    pub fn poll_message(
        &mut self,
        cx: &mut Context<'_>,