StdinLock in std::io - Rust (original) (raw)

Struct StdinLock

1.0.0 · Source

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

Expand description

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 andWrite 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(())
}

1.63.0 · Source §

Available on Windows only.

1.35.0 · Source §

Available on Windows only.

1.0.0 · Source §

Source §

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more

Source §

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

Source §

Reads all bytes into buf until the delimiter byte or EOF is reached. Read more

Source §