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 and
Write will do nothing and silently succeed. All other I/O operations, via the
standard library or via raw Windows API calls, will fail.
§Examples
Trait Implementations§
1.63.0 · Source§impl<'a> AsFd for StdinLock<'a>
 
impl<'a> AsFd for StdinLock<'a>
Source§fn as_fd(&self) -> BorrowedFd<'_>
 
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
1.63.0 · Source§impl<'a> AsHandle for StdinLock<'a>
Available on Windows only. 
impl<'a> AsHandle for StdinLock<'a>
Available on Windows only.
Source§fn as_handle(&self) -> BorrowedHandle<'_>
 
fn as_handle(&self) -> BorrowedHandle<'_>
Borrows the handle. Read more
1.35.0 · Source§impl<'a> AsRawHandle for StdinLock<'a>
Available on Windows only. 
impl<'a> AsRawHandle for StdinLock<'a>
Available on Windows only.
Source§fn as_raw_handle(&self) -> RawHandle
 
fn as_raw_handle(&self) -> RawHandle
Extracts the raw handle. Read more
1.0.0 · Source§impl BufRead for StdinLock<'_>
 
impl BufRead for StdinLock<'_>
Source§fn fill_buf(&mut self) -> Result<&[u8]>
 
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. Read more
Source§fn consume(&mut self, n: usize)
 
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. Read moreSource§fn read_line(&mut self, buf: &mut String) -> Result<usize>
 
fn read_line(&mut self, buf: &mut String) -> Result<usize>
Reads all bytes until a newline (the 
0xA byte) is reached, and append
them to the provided String buffer. Read moreSource§fn has_data_left(&mut self) -> Result<bool>
 
fn has_data_left(&mut self) -> Result<bool>
🔬This is a nightly-only experimental API. (
buf_read_has_data_left #86423)Checks if the underlying 
Read has any data left to be read. Read more1.83.0 · Source§fn skip_until(&mut self, byte: u8) -> Result<usize>
 
fn skip_until(&mut self, byte: u8) -> Result<usize>
Skips all bytes until the delimiter 
byte or EOF is reached. Read more1.70.0 · Source§impl IsTerminal for StdinLock<'_>
 
impl IsTerminal for StdinLock<'_>
Source§fn is_terminal(&self) -> bool
 
fn is_terminal(&self) -> bool
Returns 
true if the descriptor/handle refers to a terminal/tty. Read more1.0.0 · Source§impl Read for StdinLock<'_>
 
impl Read for StdinLock<'_>
Source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
 
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. Read more
Source§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()>
 
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()>
🔬This is a nightly-only experimental API. (
read_buf #78485)Pull some bytes from this source into the specified buffer. Read more
Source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
 
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
Like 
read, except that it reads into a slice of buffers. Read moreSource§fn is_read_vectored(&self) -> bool
 
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector #69941)Source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
 
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
Reads all bytes until EOF in this source, placing them into 
buf. Read moreSource§fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
 
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
Reads all bytes until EOF in this source, appending them to 
buf. Read moreSource§fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
 
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
Reads the exact number of bytes required to fill 
buf. Read moreSource§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>
 
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>
🔬This is a nightly-only experimental API. (
read_buf #78485)Reads the exact number of bytes required to fill 
cursor. Read more1.0.0 · Source§fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,
 
fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,
Creates a “by reference” adaptor for this instance of 
Read. Read moreAuto Trait Implementations§
impl<'a> Freeze for StdinLock<'a>
impl<'a> RefUnwindSafe for StdinLock<'a>
impl<'a> !Send for StdinLock<'a>
impl<'a> Sync for StdinLock<'a>
impl<'a> Unpin for StdinLock<'a>
impl<'a> UnwindSafe for StdinLock<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
 
impl<T> BorrowMut<T> for Twhere
    T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
 
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more