Skip to content

Commit

Permalink
io: clarify zero remaining capacity case (#6790)
Browse files Browse the repository at this point in the history
  • Loading branch information
rosscanning committed Aug 19, 2024
1 parent 70569bd commit 5b9a290
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion tokio/src/io/async_read.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ use std::task::{Context, Poll};
/// * `Poll::Ready(Ok(()))` means that data was immediately read and placed into
/// the output buffer. The amount of data read can be determined by the
/// increase in the length of the slice returned by `ReadBuf::filled`. If the
/// difference is 0, EOF has been reached.
/// difference is 0, either EOF has been reached, or the output buffer had zero
/// capacity (i.e. `buf.remaining()` == 0).
///
/// * `Poll::Pending` means that no data was read into the buffer
/// provided. The I/O object is not currently readable but may become readable
Expand Down

0 comments on commit 5b9a290

Please sign in to comment.