From 86b650bb8a3960f465802ac4cb47915a86c10cf6 Mon Sep 17 00:00:00 2001 From: "Stainsby, Hayden" Date: Mon, 22 Aug 2022 20:34:06 +0200 Subject: [PATCH] io: remove `PollEvented` docs reference to `clear_read_ready` The documentation for`PollEvented` had a single remaining reference to `Registration::clear_read_ready`, which no longer exists. This change updates the documentation to refer to `Registration::clear_readiness` instead. --- tokio/src/io/poll_evented.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/tokio/src/io/poll_evented.rs b/tokio/src/io/poll_evented.rs index f495fddd138..f37d4dab92d 100644 --- a/tokio/src/io/poll_evented.rs +++ b/tokio/src/io/poll_evented.rs @@ -11,7 +11,7 @@ cfg_io_driver! { /// [`std::io::Write`] traits with the reactor that drives it. /// /// `PollEvented` uses [`Registration`] internally to take a type that - /// implements [`mio::event::Source`] as well as [`std::io::Read`] and or + /// implements [`mio::event::Source`] as well as [`std::io::Read`] and/or /// [`std::io::Write`] and associate it with a reactor that will drive it. /// /// Once the [`mio::event::Source`] type is wrapped by `PollEvented`, it can be @@ -41,12 +41,12 @@ cfg_io_driver! { /// [`poll_read_ready`] again will also indicate read readiness. /// /// When the operation is attempted and is unable to succeed due to the I/O - /// resource not being ready, the caller must call `clear_readiness`. + /// resource not being ready, the caller must call [`clear_readiness`]. /// This clears the readiness state until a new readiness event is received. /// /// This allows the caller to implement additional functions. For example, /// [`TcpListener`] implements poll_accept by using [`poll_read_ready`] and - /// `clear_read_ready`. + /// [`clear_readiness`]. /// /// ## Platform-specific events /// @@ -57,6 +57,7 @@ cfg_io_driver! { /// [`AsyncRead`]: crate::io::AsyncRead /// [`AsyncWrite`]: crate::io::AsyncWrite /// [`TcpListener`]: crate::net::TcpListener + /// [`clear_readiness`]: Registration::clear_readiness /// [`poll_read_ready`]: Registration::poll_read_ready /// [`poll_write_ready`]: Registration::poll_write_ready pub(crate) struct PollEvented {