From a389d86fa46d4a01b7839560a8851d84b7b2153d Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Sun, 19 May 2013 12:33:01 -0700 Subject: [PATCH] Add docs for stdin in core::io. --- src/libcore/io.rs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/libcore/io.rs b/src/libcore/io.rs index 77b486ca44619..677903433e01c 100644 --- a/src/libcore/io.rs +++ b/src/libcore/io.rs @@ -1010,6 +1010,16 @@ pub fn FILE_reader(f: *libc::FILE, cleanup: bool) -> @Reader { // top-level functions that take a reader, or a set of default methods on // reader (which can then be called reader) +/** +* Gives a `Reader` that allows you to read values from standard input. +* +* # Examples +* ~~~ +* let stdin = core::io::stdin(); +* let line = stdin.read_line(); +* core::io::print(line); +* ~~~ +*/ pub fn stdin() -> @Reader { unsafe { @rustrt::rust_get_stdin() as @Reader