diff options
| author | Diggory Blake <diggsey@googlemail.com> | 2018-01-13 18:44:25 +0000 |
|---|---|---|
| committer | Diggory Blake <diggsey@googlemail.com> | 2018-01-13 18:44:25 +0000 |
| commit | c96f30257aa7e86fd5b7f657d7b0bc21dcf45b1f (patch) | |
| tree | 25493a4ca80e570e16c442549091bc5696eb6f86 /src/libstd | |
| parent | 562ba04e454e86bfedb332d5c7194449113bc5cb (diff) | |
| download | rust-c96f30257aa7e86fd5b7f657d7b0bc21dcf45b1f.tar.gz rust-c96f30257aa7e86fd5b7f657d7b0bc21dcf45b1f.zip | |
Add note to documentation
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/io/buffered.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs index df1609ace87..c23224c92b9 100644 --- a/src/libstd/io/buffered.rs +++ b/src/libstd/io/buffered.rs @@ -285,6 +285,8 @@ impl<R: Seek> Seek for BufReader<R> { /// `.into_inner()` immediately after a seek yields the underlying reader /// at the same position. /// + /// To seek without discarding the internal buffer, use [`seek_relative`]. + /// /// See `std::io::Seek` for more details. /// /// Note: In the edge case where you're seeking with `SeekFrom::Current(n)` @@ -292,6 +294,8 @@ impl<R: Seek> Seek for BufReader<R> { /// seeks will be performed instead of one. If the second seek returns /// `Err`, the underlying reader will be left at the same position it would /// have if you seeked to `SeekFrom::Current(0)`. + /// + /// [`seek_relative`]: #method.seek_relative fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> { let result: u64; if let SeekFrom::Current(n) = pos { |
