diff options
author | Justus Winter <justus@sequoia-pgp.org> | 2020-10-20 14:25:31 +0200 |
---|---|---|
committer | Justus Winter <justus@sequoia-pgp.org> | 2020-10-20 16:09:58 +0200 |
commit | 6a425698b77253afdba1b3b937af98273edfcfa2 (patch) | |
tree | 92ffa0848ae085546e98aead06c366841674abc0 /buffered-reader | |
parent | fe74d990ead947de52f0165979fecc2f30a7cf25 (diff) |
buffered-reader: Improve documentation.
Diffstat (limited to 'buffered-reader')
-rw-r--r-- | buffered-reader/src/generic.rs | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/buffered-reader/src/generic.rs b/buffered-reader/src/generic.rs index be57d0c9..408ab93b 100644 --- a/buffered-reader/src/generic.rs +++ b/buffered-reader/src/generic.rs @@ -7,8 +7,12 @@ use super::*; /// Wraps a `Read`er. /// -/// This is useful when reading from a file, and it even works with a -/// `&[u8]` (but `Memory` is more efficient). +/// This is useful when reading from a generic `std::io::Read`er. To +/// read from a file, use [`File`]. To read from a buffer, use +/// [`Memory`]. Both are more efficient than `Generic`. +/// +/// [`File`]: struct.File.html +/// [`Memory`]: struct.Memory.html pub struct Generic<T: io::Read, C> { buffer: Option<Box<[u8]>>, // The next byte to read in the buffer. |