rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Improve rewind documentation

Browse Source
This commit is contained in:
Sean Linsley
2023-10-16 12:41:43 -05:00
committed by GitHub
parent 98c1e3d95b
commit 1fb00335df
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
library/std/src/io/mod.rs
View File

@@ -556,6 +556,10 @@ where
/// therefore, using something that implements [`BufRead`], such as /// therefore, using something that implements [`BufRead`], such as
/// [`BufReader`], will be more efficient. /// [`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 /// # Examples
/// ///
/// [`File`]s implement `Read`: /// [`File`]s implement `Read`: