Struct std::io::StdinLock

[+] Show declaration

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

[−] 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 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.

Trait Implementations

impl<'_> Read for StdinLock<'_>[+]

[+] Show hidden undocumented items

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.

unsafe fn initializer(&self) -> Initializer[−]

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

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

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.

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W

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

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

Important traits for Bytes<R>

impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;

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

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

Important traits for Chain<T, U>

impl<T: Read, U: Read> Read for Chain<T, U>

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

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T: Read> Read for Take<T>

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

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

impl<'_> BufRead for StdinLock<'_>[+]

[+] Show hidden undocumented items

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.

Important traits for Split<B>

impl<B: BufRead> Iterator for Split<B> type Item = Result<Vec<u8>>;

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

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

Important traits for Lines<B>

impl<B: BufRead> Iterator for Lines<B> type Item = Result<String>;

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

Returns an iterator over the lines of this reader.

impl<'a> AsRawFd for StdinLock<'a>[+]

[+] Show hidden undocumented items

fn as_raw_fd(&self) -> RawFd[−]

This is supported on Unix only.

Extracts the raw file descriptor.

impl<'a> AsRawHandle for StdinLock<'a>[+]

[+] Show hidden undocumented items

fn as_raw_handle(&self) -> RawHandle[−]

This is supported on Windows only.

Extracts the raw handle, without taking any ownership.

impl<'_> Debug for StdinLock<'_>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.