Skip to content

Commit 1fb0033

Browse files
authored
Improve rewind documentation
1 parent 98c1e3d commit 1fb0033

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

library/std/src/io/mod.rs

+4
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,10 @@ where
556556
/// therefore, using something that implements [`BufRead`], such as
557557
/// [`BufReader`], will be more efficient.
558558
///
559+
/// Repeated calls to the reader use the same cursor, so for example
560+
/// calling `read_to_end` twice on a [`File`] will only return the file's
561+
/// contents once. It's recommended to first call `rewind()` in that case.
562+
///
559563
/// # Examples
560564
///
561565
/// [`File`]s implement `Read`:

0 commit comments

Comments
 (0)