Struct std::io::StdinLock

pub struct StdinLock<'a> { /* private fields */ }

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 Considerations

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.

In a process with a detached console, such as one using #![windows_subsystem = "windows"], or in a child process spawned from such a process, the contained handle will be null. In such cases, the standard library’s Read and Write will do nothing and silently succeed. All other I/O operations, via the standard library or via raw Windows API calls, will fail.

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<'_>

🔬 This is a nightly-only experimental API. (io_safety #87074)

This is supported on Unix only.

Borrows the file descriptor.

impl<'a> AsHandle for StdinLock<'a>

This is supported on Windows only.

fn as_handle(&self) -> BorrowedHandle<'_>

🔬 This is a nightly-only experimental API. (io_safety #87074)

Borrows the handle.

impl<'a> AsRawFd for StdinLock<'a>

fn as_raw_fd(&self) -> RawFd

This is supported on Unix only.

Extracts the raw file descriptor.

impl<'a> AsRawHandle for StdinLock<'a>

This is supported on Windows only.

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle.

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.

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.

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.

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. You do not need to clear the buffer before appending.

fn has_data_left(&mut self) -> Result<bool>

🔬 This is a nightly-only experimental API. (buf_read_has_data_left #86423)

Check if the underlying Read has any data left to be read.

fn split(self, byte: u8) -> Split<Self> where
    Self: Sized, 

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self> where
    Self: Sized, 

Returns an iterator over the lines of this reader.

impl Debug for StdinLock<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector #69941)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<()>

🔬 This is a nightly-only experimental API. (read_buf #78485)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<()>

🔬 This is a nightly-only experimental API. (read_buf #78485)

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self> where
    Self: Sized, 

Transforms this Read instance to an Iterator over its bytes.

fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
    Self: Sized, 

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, 

Creates an adapter which will read at most limit bytes from it.