Doc: next_batch() example

Freaky · Apr 23, 2018 · f5ed673 · f5ed673
1 parent c129a8b
commit f5ed673
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -175,6 +175,19 @@ impl<R: io::Read> LineReader<R> {
     ///
     /// The copy is left up to you in case you have other reasons for wanting
     /// batches.  Something higher level, like an iterator, will be forthcoming.
+    ///
+    /// ```no_run
+    /// # use linereader::LineReader;
+    /// # use std::fs::File;
+    /// # use std::io;
+    /// # fn x() -> io::Result<()> {
+    /// # let mut reader = LineReader::new(File::open("myfile.txt")?);
+    /// while let Some(lines) = reader.next_batch() {
+    ///     let lines = lines?;  // unwrap io::Result to &[u8]
+    /// }
+    /// # Ok(())
+    /// # }
+    /// ```
     pub fn next_batch(&mut self) -> Option<io::Result<&[u8]>> {
         if self.pos < self.end_of_complete {
             let ret = &self.buf[self.pos..self.end_of_complete];