Skip to content

Commit 32f7e67

Browse files
committed
Refine read_to_end documentation
1 parent 5245475 commit 32f7e67

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

src/libstd/io/mod.rs

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -172,14 +172,11 @@ pub trait Read {
172172
/// Read all bytes until EOF in this source, placing them into `buf`.
173173
///
174174
/// All bytes read from this source will be appended to the specified buffer
175-
/// `buf`. This function will return a call to `read` either:
175+
/// `buf`. This function will continuously call `read` to append more data to
176+
/// `buf` until `read` returns either `Ok(0)` or an error of
177+
/// non-`ErrorKind::Interrupted` kind.
176178
///
177-
/// 1. Returns `Ok(0)`.
178-
/// 2. Returns an error which is not of the kind `ErrorKind::Interrupted`.
179-
///
180-
/// Until one of these conditions is met the function will continuously
181-
/// invoke `read` to append more data to `buf`. If successful, this function
182-
/// will return the total number of bytes read.
179+
/// If successful, this function will return the total number of bytes read.
183180
///
184181
/// # Errors
185182
///

0 commit comments

Comments
 (0)