From d776191d4a84dd13080b3efdb449e4c036eb3f7e Mon Sep 17 00:00:00 2001 From: Matt Brubeck Date: Tue, 19 May 2015 09:49:04 -0700 Subject: Add example code and cross-link to BufReader docs --- src/libstd/io/buffered.rs | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'src/libstd/io/buffered.rs') diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs index 43a26292618..c355be9bc78 100644 --- a/src/libstd/io/buffered.rs +++ b/src/libstd/io/buffered.rs @@ -27,6 +27,24 @@ use iter; /// For example, every call to `read` on `TcpStream` results in a system call. /// A `BufReader` performs large, infrequent reads on the underlying `Read` /// and maintains an in-memory buffer of the results. +/// +/// # Examples +/// +/// ```no_run +/// use std::io::prelude::*; +/// use std::io::BufReader; +/// use std::fs::File; +/// +/// # fn foo() -> std::io::Result<()> { +/// let mut f = try!(File::open("log.txt")); +/// let mut reader = BufReader::new(f); +/// +/// let mut line = String::new(); +/// let len = try!(reader.read_line(&mut line)); +/// println!("First line is {} bytes long", len); +/// # Ok(()) +/// # } +/// ``` #[stable(feature = "rust1", since = "1.0.0")] pub struct BufReader { inner: R, -- cgit 1.4.1-3-g733a5