Struct async_std::io::Stdin

pub struct Stdin(_);

A handle to the standard input of the current process.

This reader is created by the stdin function. See its documentation for more.

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 write bytes that are not valid UTF-8 will return an error.

Methods

impl Stdin

pub async fn read_line<'_, '_>(&'_ self, buf: &'_ mut String) -> Result<usize>

Reads a line of input into the specified buffer.

Examples

use async_std::io;

let stdin = io::stdin();
let mut line = String::new();
stdin.read_line(&mut line).await?;

pub async fn lock<'_>(&'_ self) -> StdinLock<'static>

This is supported on unstable only.

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 trait for accessing the underlying data.

Examples

use async_std::io;
use async_std::prelude::*;

let mut buffer = String::new();

let stdin = io::stdin();
let mut handle = stdin.lock().await;

handle.read_to_string(&mut buffer).await?;

Trait Implementations

impl Read for Stdin

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads some bytes from the byte stream.

fn read_vectored<'a>(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

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

fn read_to_end<'a>(
    &'a mut self,
    buf: &'a mut Vec<u8>
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream.

fn read_to_string<'a>(
    &'a mut self,
    buf: &'a mut String
) -> ImplFuture<Result<usize>> where
    Self: Unpin, 

Reads all bytes from the byte stream and appends them into a string.

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ImplFuture<Result<()>> where
    Self: Unpin, 

Reads the exact number of bytes required to fill buf.

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

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

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 a Stream over its bytes.

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

Creates an adaptor which will chain this stream with another.

impl AsRawFd for Stdin

fn as_raw_fd(&self) -> RawFd

This is supported on Unix only.

Extracts the raw file descriptor.

impl AsRawHandle for Stdin

fn as_raw_handle(&self) -> RawHandle

This is supported on Windows only.

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.