Struct std::io::StdinLock
pub struct StdinLock<'a> { /* fields omitted */ }
A locked reference to the Stdin handle.
This handle implements both the Read and BufRead traits, and is constructed via the Stdin::lock 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::{self, BufRead};
fn main() -> io::Result<()> {
let mut buffer = String::new();
let stdin = io::stdin(); // We get `Stdin` here.
{
let mut handle = stdin.lock(); // We get `StdinLock` here.
handle.read_line(&mut buffer)?;
} // `StdinLock` is dropped here.
Ok(())
}Trait Implementations
impl<'a> AsFd for StdinLock<'a>
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
impl<'a> AsRawFd for StdinLock<'a>
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 BufRead for StdinLock<'_>
fn fill_buf(&mut self) -> Result<&[u8]>
Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more
fn consume(&mut self, n: usize)
Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read. Read more
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>
Read all bytes into buf until the delimiter byte or EOF is reached. Read more
fn read_line(&mut self, buf: &mut String) -> Result<usize>
Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more
fn has_data_left(&mut self) -> Result<bool>
buf_read_has_data_left #86423)recently added
Check if the underlying Read has any data left to be read. Read more
impl<B: BufRead> Iterator for Split<B>
type Item = Result<Vec<u8>>;
Returns an iterator over the contents of this reader split on the byte byte. Read more
impl<B: BufRead> Iterator for Lines<B>
type Item = Result<String>;
Returns an iterator over the lines of this reader. Read more
impl Debug for StdinLock<'_>
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
impl Read for StdinLock<'_>
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 Reader has an efficient read_vectored implementation. Read more
unsafe fn initializer(&self) -> Initializer
Determines if this Reader 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<'a> RefUnwindSafe for StdinLock<'a>
impl<'a> !Send for StdinLock<'a>
impl<'a> Sync for StdinLock<'a>
impl<'a> Unpin for StdinLock<'a>
impl<'a> UnwindSafe for StdinLock<'a>
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.StdinLock.html