io: add doc warning about concurrently calling poll_read/write_ready (#…

…2439) Co-authored-by: Alice Ryhl <[email protected]> Fixes: #2429
tokio-rs · May 11, 2020 · 3ba818a · 3ba818a
1 parent 6aeeeff
commit 3ba818a
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/tokio/src/io/poll_evented.rs b/tokio/src/io/poll_evented.rs
@@ -261,6 +261,11 @@ where
     ///
     /// * `ready` includes writable.
     /// * called from outside of a task context.
+    ///
+    /// # Warning
+    ///
+    /// This method may not be called concurrently. It takes `&self` to allow
+    /// calling it concurrently with `poll_write_ready`.
     pub fn poll_read_ready(
         &self,
         cx: &mut Context<'_>,
@@ -327,6 +332,11 @@ where
     ///
     /// * `ready` contains bits besides `writable` and `hup`.
     /// * called from outside of a task context.
+    ///
+    /// # Warning
+    ///
+    /// This method may not be called concurrently. It takes `&self` to allow
+    /// calling it concurrently with `poll_read_ready`.
     pub fn poll_write_ready(&self, cx: &mut Context<'_>) -> Poll<io::Result<mio::Ready>> {
         poll_ready!(
             self,