Skip to content

net: document pipe try_read*/try_write* readiness behavior #8032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattiapitossi merged 4 commits into from
Apr 19, 2026
+50 −0
Merged

net: document pipe try_read*/try_write* readiness behavior #8032

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
adef662
net: document pipe try_read*/try_write* readiness behavior
barry3406 Apr 10, 2026
ac68806
address review: soften Notes wording per Darksonn's suggestion
barry3406 Apr 12, 2026
3c06d4b
fix WouldBlock intra-doc link
barry3406 Apr 16, 2026
41e2b0b
Merge branch 'master' into fix/pipe-try-read-readiness-v2
mattiapitossi Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions tokio/src/net/unix/pipe.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,13 @@ impl Sender {
/// number of bytes written. If the pipe is not ready to write data,
/// `Err(io::ErrorKind::WouldBlock)` is returned.
///
/// # Notes
///
/// The runtime's I/O driver only delivers readiness events to a `Sender`
/// after control is yielded back to it. Calling this method before any
/// `.await` (such as [`writable`]) will return `WouldBlock` even when
/// the pipe has space available.
Comment thread
barry3406 marked this conversation as resolved.
Outdated
///
/// # Examples
///
/// ```no_run
Expand Down Expand Up @@ -681,6 +688,13 @@ impl Sender {
/// number of bytes written. If the pipe is not ready to write data,
/// `Err(io::ErrorKind::WouldBlock)` is returned.
///
/// # Notes
///
/// The runtime's I/O driver only delivers readiness events to a `Sender`
/// after control is yielded back to it. Calling this method before any
/// `.await` (such as [`writable`]) will return `WouldBlock` even when
/// the pipe has space available.
///
/// # Examples
///
/// ```no_run
Expand Down Expand Up @@ -1120,6 +1134,13 @@ impl Receiver {
/// If the pipe is not ready to read data,
/// `Err(io::ErrorKind::WouldBlock)` is returned.
///
/// # Notes
///
/// The runtime's I/O driver only delivers readiness events to a `Receiver`
/// after control is yielded back to it. Calling this method before any
/// `.await` (such as [`readable()`]) will return `WouldBlock` even when
/// data is already available in the pipe.
///
/// # Examples
///
/// ```no_run
Expand Down Expand Up @@ -1188,6 +1209,13 @@ impl Receiver {
/// closed and will no longer write data. If the pipe is not ready to read
/// data `Err(io::ErrorKind::WouldBlock)` is returned.
///
/// # Notes
///
/// The runtime's I/O driver only delivers readiness events to a `Receiver`
/// after control is yielded back to it. Calling this method before any
/// `.await` (such as [`readable()`]) will return `WouldBlock` even when
/// data is already available in the pipe.
///
/// # Examples
///
/// ```no_run
Expand Down Expand Up @@ -1258,6 +1286,13 @@ impl Receiver {
/// closed and will no longer write data. If the pipe is not ready to read
/// data `Err(io::ErrorKind::WouldBlock)` is returned.
///
/// # Notes
///
/// The runtime's I/O driver only delivers readiness events to a `Receiver`
/// after control is yielded back to it. Calling this method before any
/// `.await` (such as [`readable()`]) will return `WouldBlock` even when
/// data is already available in the pipe.
///
/// # Examples
///
/// ```no_run
Expand Down
Loading