W3cubDocs

/Rust

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.

Methods

impl Stdin [src]

[src]

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, Read};

let mut buffer = String::new();
let stdin = io::stdin();
let mut handle = stdin.lock();

handle.read_to_string(&mut buffer)?;

[src]

Locks this handle and reads a line of input into 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

Trait Implementations

impl Debug for Stdin
1.16.0
[src]

[src]

Formats the value using the given formatter. Read more

impl Read for Stdin [src]

[src]

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

[src]

🔬 This is a nightly-only experimental API. (read_initializer #42788)

Determines if this Reader can work with buffers of uninitialized memory. Read more

[src]

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

[src]

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

[src]

Read the exact number of bytes required to fill buf. Read more

[src]

Creates a "by reference" adaptor for this instance of Read. Read more

[src]

Transforms this Read instance to an [Iterator] over its bytes. Read more

[src]

🔬 This is a nightly-only experimental API. (io #27802)the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s. Read more

[src]

Creates an adaptor which will chain this stream with another. Read more

[src]

Creates an adaptor which will read at most limit bytes from it. Read more

impl AsRawFd for Stdin
1.21.0
[src]

[src]

This is supported on Unix only.

Extracts the raw file descriptor. Read more

impl AsRawHandle for Stdin
1.21.0
[src]

[src]

This is supported on Windows only.

Extracts the raw handle, without taking any ownership.

© 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