tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-08-24 00:00:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

io: fix docs referring to clear_{read,write}_ready (#3957)

Browse Source
This commit is contained in:
Blas Rodriguez Irizar
2021-07-20 15:35:18 +02:00
committed by GitHub
parent 252004811f
commit 5ae2855eaf
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/io/poll_evented.rs
+2 -3
View File
@@ -40,9 +40,8 @@ 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_read_ready` or
/// `clear_write_ready`. This clears the readiness state until a new
/// readiness event is received.
/// 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