doc: Add Cancel safety description for AsyncFd's methods #6662

howjmay · 2024-06-27T16:15:38Z

Darksonn · 2024-06-28T07:34:47Z

tokio/src/io/async_fd.rs

@@ -700,6 +700,7 @@ impl<T: AsRawFd> AsyncFd<T> {
    /// concurrently with other methods on this struct. This method only
    /// provides shared access to the inner IO resource when handling the
    /// [`AsyncFdReadyGuard`].
+    /// This method is cancellation safe.


Please add this information like for other methods. For example, TcpStream::readable does it like this:

Suggested change

/// This method is cancellation safe.

/// # Cancel safety

///

/// This method is cancel safe. Once a readiness event occurs, the method

/// will continue to return immediately until the readiness event is

/// consumed by an attempt to read that fails with `WouldBlock` or

/// `Poll::Pending`.

doc: Add Cancel safety description for AsyncFd's methods

4f287b2

closes tokio-rs#6654

Darksonn reviewed Jun 28, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Add Cancel safety description for AsyncFd's methods #6662

doc: Add Cancel safety description for AsyncFd's methods #6662

howjmay commented Jun 27, 2024

Darksonn Jun 28, 2024

-    /// This method is cancellation safe.
+    /// # Cancel safety
+    ///
+    /// This method is cancel safe. Once a readiness event occurs, the method
+    /// will continue to return immediately until the readiness event is
+    /// consumed by an attempt to read that fails with `WouldBlock` or
+    /// `Poll::Pending`.

doc: Add Cancel safety description for AsyncFd's methods #6662

Are you sure you want to change the base?

doc: Add Cancel safety description for AsyncFd's methods #6662

Conversation

howjmay commented Jun 27, 2024

Darksonn Jun 28, 2024

Choose a reason for hiding this comment