Struct std::io::Stdin
pub struct Stdin { /* fields omitted */ }
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
impl Stdin
pub fn lock(&self) -> StdinLock<'_>
impl Read for StdinLock<'_>
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(()) }
pub fn read_line(&self, buf: &mut String) -> Result<usize>
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>
impl Read for StdinLock<'_>
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(()) }
pub fn lines(self) -> Lines<StdinLock<'static>>
impl<B: BufRead> Iterator for Lines<B> type Item = Result<String>;
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()); }
pub fn split(self, byte: u8) -> Split<StdinLock<'static>>
impl<B: BufRead> Iterator for Split<B> type Item = Result<Vec<u8>>;
Consumes this handle and returns an iterator over input bytes, split at the specified byte value.
For detailed semantics of this method, see the documentation on BufRead::split
.
Examples
#![feature(stdin_forwarders)] use std::io; let splits = io::stdin().split(b'-'); for split in splits { println!("got a chunk: {}", String::from_utf8_lossy(&split.unwrap())); }
Trait Implementations
impl AsFd for Stdin
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
impl AsRawFd for Stdin
fn as_raw_fd(&self) -> RawFd
Extracts the raw file descriptor. Read more
fn as_raw_handle(&self) -> RawHandle
Extracts the raw handle, without taking any ownership.
impl Debug for Stdin
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl Read for Stdin
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
Like read
, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool
Determines if this Read
er has an efficient read_vectored
implementation. Read more
unsafe fn initializer(&self) -> Initializer
Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
Read the exact number of bytes required to fill buf
. Read more
Creates a “by reference” adapter for this instance of Read
. Read more
impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;
impl<T: Read, U: Read> Read for Chain<T, U>
Creates an adapter which will chain this stream with another. Read more
impl<T: Read> Read for Take<T>
Creates an adapter which will read at most limit
bytes from it. Read more
Auto Trait Implementations
impl RefUnwindSafe for Stdin
impl Send for Stdin
impl Sync for Stdin
impl Unpin for Stdin
impl UnwindSafe for Stdin
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/io/struct.Stdin.html