Improve rewind documentation

rust-lang-ci · Oct 16, 2023 · 1fb0033 · 1fb0033
1 parent 98c1e3d
commit 1fb0033
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/library/std/src/io/mod.rs b/library/std/src/io/mod.rs
@@ -556,6 +556,10 @@ where
 /// therefore, using something that implements [`BufRead`], such as
 /// [`BufReader`], will be more efficient.
 ///
+/// Repeated calls to the reader use the same cursor, so for example
+/// calling `read_to_end` twice on a [`File`] will only return the file's
+/// contents once. It's recommended to first call `rewind()` in that case.
+///
 /// # Examples
 ///
 /// [`File`]s implement `Read`: