buffered-reader: Add BufferedReaderDup.

  - Add a new BufferedReader implementation that allows using a
    BufferedReader as usual, but without actually consuming the data.

1 files changed, 5 insertions, 0 deletions

diff --git a/buffered-reader/src/lib.rs b/buffered-reader/src/lib.rs
index ae2d44ed..ab19fa37 100644
--- a/buffered-reader/src/lib.rs
+++ b/buffered-reader/src/lib.rs
@@ -11,12 +11,14 @@ use std::fmt;
 mod generic;
 mod memory;
 mod limitor;
+mod dup;
 mod eof;
 mod decompress;
 
 pub use self::generic::BufferedReaderGeneric;
 pub use self::memory::BufferedReaderMemory;
 pub use self::limitor::BufferedReaderLimitor;
+pub use self::dup::BufferedReaderDup;
 pub use self::eof::BufferedReaderEOF;
 pub use self::decompress::BufferedReaderDeflate;
 pub use self::decompress::BufferedReaderZlib;
@@ -116,6 +118,9 @@ pub trait BufferedReader<C> : io::Read + fmt::Debug {
 
     /// This is a convenient function that effectively combines data()
     /// and consume().
+    ///
+    /// If less than `amount` bytes are available, this consumes only
+    /// what is available.
     fn data_consume(&mut self, amount: usize)
                     -> Result<&[u8], std::io::Error>;