Skip to content

Doc: clarify how Read::bytes handling Interrupted errors #161318

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
rust-bors merged 1 commit into from
Aug 19, 2026
+8 −0
Merged

Doc: clarify how Read::bytes handling Interrupted errors #161318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions library/alloc/src/io/read.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,14 @@ pub trait Read {
/// which can be very inefficient for data that's not in memory,
/// such as `File`. Consider using a `BufReader` in such cases.
///
/// # Errors
///
/// When the returned iterator calls [`Iterator::next`],
/// if it encounters an error of the kind [`ErrorKind::Interrupted`]
/// then the error is ignored and it will try to read the byte again.
///
/// [`ErrorKind::Interrupted`]: crate::io::ErrorKind::Interrupted
///
/// # Examples
///
/// `File`s implement `Read`:
Expand Down
Loading