Struct async_std::io::Stdin

source · [−]

pub struct Stdin(_);

Expand description

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

Implementations

source

impl Stdin

source

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?;

Trait Implementations

source

impl AsRawFd for Stdin

Available on Unix only.

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl AsRawHandle for Stdin

Available on Windows only.

source

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

source

impl AsyncRead for Stdin

source

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

Attempt to read from the AsyncRead into buf. Read more

source

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

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

source

impl Debug for Stdin

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for Stdin

impl Send for Stdin

impl Sync for Stdin

impl Unpin for Stdin

impl UnwindSafe for Stdin

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

source

fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>ⓘNotable traits for ReadFuture<'_, R>`impl<'_, R> Future for ReadFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

Reads some bytes from the byte stream. Read more

source

fn read_vectored(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>ⓘNotable traits for ReadVectoredFuture<'_, R>`impl<'_, R> Future for ReadVectoredFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
 Self: Unpin,

Like read(), except it reads into a slice of buffers. Read more

source

fn read_to_end(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self>ⓘNotable traits for ReadToEndFuture<'_, R>`impl<'_, R> Future for ReadToEndFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
 Self: Unpin,

Reads the entire contents and appends them to a Vec. Read more

source

fn read_to_string(
 &'a mut self,
 buf: &'a mut String
) -> ReadToStringFuture<'a, Self>ⓘNotable traits for ReadToStringFuture<'_, R>`impl<'_, R> Future for ReadToStringFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
 Self: Unpin,

Reads the entire contents and appends them to a String. Read more

source

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>ⓘNotable traits for ReadExactFuture<'_, R>`impl<'_, R> Future for ReadExactFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

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

source

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

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

source

fn bytes(self) -> Bytes<Self>

Converts this AsyncRead into a Stream of bytes. Read more

source

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

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

source

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>>ⓘNotable traits for Pin`impl Future for Pin where P: DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;` where
Self: 'a + Send,

Boxes the reader and changes its type to dyn AsyncRead + Send + 'a. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct async_std::io::Stdin

Implementations

impl Stdin

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

Trait Implementations

impl AsRawFd for Stdin

fn as_raw_fd(&self) -> RawFd

impl AsRawHandle for Stdin

fn as_raw_handle(&self) -> RawHandle

impl AsyncRead for Stdin

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

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

impl Debug for Stdin

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

Auto Trait Implementations

impl RefUnwindSafe for Stdin

impl Send for Stdin

impl Sync for Stdin

impl Unpin for Stdin

impl UnwindSafe for Stdin

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for R where R: AsyncRead + ?Sized,

fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>ⓘNotable traits for ReadFuture<'_, R>impl<'_, R> Future for ReadFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where Self: Unpin,

fn read_vectored( &'a mut self, bufs: &'a mut [IoSliceMut<'a>]) -> ReadVectoredFuture<'a, Self>ⓘNotable traits for ReadVectoredFuture<'_, R>impl<'_, R> Future for ReadVectoredFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where Self: Unpin,

fn read_to_end( &'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEndFuture<'a, Self>ⓘNotable traits for ReadToEndFuture<'_, R>impl<'_, R> Future for ReadToEndFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where Self: Unpin,

fn read_to_string( &'a mut self, buf: &'a mut String) -> ReadToStringFuture<'a, Self>ⓘNotable traits for ReadToStringFuture<'_, R>impl<'_, R> Future for ReadToStringFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>; where Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>ⓘNotable traits for ReadExactFuture<'_, R>impl<'_, R> Future for ReadExactFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<(), Error>; where Self: Unpin,

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

fn bytes(self) -> Bytes<Self>

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

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a + Send,

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>ⓘNotable traits for ReadFuture<'_, R>`impl<'_, R> Future for ReadFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>ⓘNotable traits for ReadVectoredFuture<'_, R>`impl<'_, R> Future for ReadVectoredFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self>ⓘNotable traits for ReadToEndFuture<'_, R>`impl<'_, R> Future for ReadToEndFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn read_to_string(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self>ⓘNotable traits for ReadToStringFuture<'_, R>`impl<'_, R> Future for ReadToStringFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<usize, Error>;` where
Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>ⓘNotable traits for ReadExactFuture<'_, R>`impl<'_, R> Future for ReadExactFuture<'_, R> where R: AsyncRead + Unpin + ?Sized, type Output = Result<(), Error>;` where
Self: Unpin,

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

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>>ⓘNotable traits for Pin<P>`impl<P> Future for Pin<P> where P: DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;` where
Self: 'a + Send,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,