itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-10-01 12:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

io: remove PollEvented docs reference to clear_read_ready (#4931)

Browse Source 
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.
This commit is contained in:
Hayden Stainsby 2022-08-23 08:47:59 +02:00 committed by GitHub
parent f5c1ff7599
commit e005b6c899
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tokio/src/io/poll_evented.rs
View File

@ -11,7 +11,7 @@ cfg_io_driver! {
/// [`std::io::Write`] traits with the reactor that drives it. /// [`std::io::Write`] traits with the reactor that drives it.
/// ///
/// `PollEvented` uses [`Registration`] internally to take a type that /// `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. /// [`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 /// 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. /// [`poll_read_ready`] again will also indicate read readiness.
/// ///
/// When the operation is attempted and is unable to succeed due to the I/O /// 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 clears the readiness state until a new readiness event is received.
/// ///
/// This allows the caller to implement additional functions. For example, /// This allows the caller to implement additional functions. For example,
/// [`TcpListener`] implements poll_accept by using [`poll_read_ready`] and /// [`TcpListener`] implements poll_accept by using [`poll_read_ready`] and
/// `clear_read_ready`. /// [`clear_readiness`].
/// ///
/// ## Platform-specific events /// ## Platform-specific events
/// ///
@ -57,6 +57,7 @@ cfg_io_driver! {
/// [`AsyncRead`]: crate::io::AsyncRead /// [`AsyncRead`]: crate::io::AsyncRead
/// [`AsyncWrite`]: crate::io::AsyncWrite /// [`AsyncWrite`]: crate::io::AsyncWrite
/// [`TcpListener`]: crate::net::TcpListener /// [`TcpListener`]: crate::net::TcpListener
/// [`clear_readiness`]: Registration::clear_readiness
/// [`poll_read_ready`]: Registration::poll_read_ready /// [`poll_read_ready`]: Registration::poll_read_ready
/// [`poll_write_ready`]: Registration::poll_write_ready /// [`poll_write_ready`]: Registration::poll_write_ready
pub(crate) struct PollEvented<E: Source> { pub(crate) struct PollEvented<E: Source> {