pub struct Stdin { /* private fields */ }Expand description
A handle to the standard input stream of a process.
Each handle is a shared reference to a global buffer of input data to this
process. A handle can be lock’d to gain full access to BufRead methods
(e.g., .lines()). Reads to this handle are otherwise locked with respect
to other reads.
This handle implements the Read trait, but beware that concurrent reads
of Stdin must be executed with care.
Created by the io::stdin method.
Note: Windows Portability Consideration
When operating in a console, the Windows implementation of this stream does not support non-UTF-8 byte sequences. Attempting to read bytes that are not valid UTF-8 will return an error.
Examples
use std::io;
fn main() -> io::Result<()> {
let mut buffer = String::new();
let mut stdin = io::stdin(); // We get `Stdin` here.
stdin.read_line(&mut buffer)?;
Ok(())
}Implementations
Locks this handle to the standard input stream, returning a readable guard.
The lock is released when the returned lock goes out of scope. The
returned guard also implements the Read and BufRead traits for
accessing the underlying data.
Examples
use std::io::{self, BufRead};
fn main() -> io::Result<()> {
let mut buffer = String::new();
let stdin = io::stdin();
let mut handle = stdin.lock();
handle.read_line(&mut buffer)?;
Ok(())
}Locks this handle and reads a line of input, appending it to the specified buffer.
For detailed semantics of this method, see the documentation on
BufRead::read_line.
Examples
use std::io;
let mut input = String::new();
match io::stdin().read_line(&mut input) {
Ok(n) => {
println!("{} bytes read", n);
println!("{}", input);
}
Err(error) => println!("error: {}", error),
}You can run the example one of two ways:
- Pipe some text to it, e.g.,
printf foo | path/to/executable - Give it text interactively by running the executable directly, in which case it will wait for the Enter key to be pressed before continuing
pub fn into_locked(self) -> StdinLock<'static>ⓘ
pub fn into_locked(self) -> StdinLock<'static>ⓘ
Consumes this handle to the standard input stream, locking the shared global buffer associated with the stream and returning a readable guard.
The lock is released when the returned guard goes out of scope. The
returned guard also implements the Read and BufRead traits
for accessing the underlying data.
It is often simpler to directly get a locked handle using the
stdin_locked function instead, unless nearby code also needs to
use an unlocked handle.
Examples
#![feature(stdio_locked)]
use std::io::{self, BufRead};
fn main() -> io::Result<()> {
let mut buffer = String::new();
let mut handle = io::stdin().into_locked();
handle.read_line(&mut buffer)?;
Ok(())
}Consumes this handle and returns an iterator over input lines.
For detailed semantics of this method, see the documentation on
BufRead::lines.
Examples
#![feature(stdin_forwarders)]
use std::io;
let lines = io::stdin().lines();
for line in lines {
println!("got a line: {}", line.unwrap());
}Trait Implementations
Extracts the raw handle, without taking any ownership.
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Like read, except that it reads into a slice of buffers. Read more
Read all bytes until EOF in this source, placing them into buf. Read more
Read all bytes until EOF in this source, appending them to buf. Read more
Read the exact number of bytes required to fill buf. Read more
Creates a “by reference” adaptor for this instance of Read. Read more
Creates an adapter which will chain this stream with another. Read more