Skip to content

Commit 451683f

Browse files
Add doc example for Stdin
1 parent aad5f6f commit 451683f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/libstd/io/stdio.rs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,21 @@ impl Stdin {
240240
///
241241
/// [`Read`]: trait.Read.html
242242
/// [`BufRead`]: trait.BufRead.html
243+
///
244+
/// # Examples
245+
///
246+
/// ```
247+
/// use std::io::{self, Read};
248+
///
249+
/// # fn foo() -> io::Result<String> {
250+
/// let mut buffer = String::new();
251+
/// let stdin = io::stdin();
252+
/// let mut handle = stdin.lock();
253+
///
254+
/// try!(handle.read_to_string(&mut buffer));
255+
/// # Ok(buffer)
256+
/// # }
257+
/// ```
243258
#[stable(feature = "rust1", since = "1.0.0")]
244259
pub fn lock(&self) -> StdinLock {
245260
StdinLock { inner: self.inner.lock().unwrap_or_else(|e| e.into_inner()) }

0 commit comments

Comments
 (0)