Skip to content

Struct std::io::StdinLock

Stdin 句柄的锁定引用。

该句柄同时实现 ReadBufRead traits,并通过 Stdin::lock 方法构造。

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

Note: Windows 可移植性注意事项

在控制台中操作时,此流的 Windows 实现不支持非 UTF-8 字节序列。 尝试读取无效的 UTF-8 字节将返回错误。

在具有分离控制台的进程中,例如使用 #![windows_subsystem = "windows"] 的进程,或在从此类进程派生的子进程中,包含的句柄将为空。

在这种情况下,标准库的 ReadWrite 将什么都不做,默默地成功。 通过标准库或通过原始 Windows API 调用的所有其他 I/O 操作都将失败。

示例

rust
use std::io::{self, BufRead};

fn main() -> io::Result<()> {
    let mut buffer = String::new();
    let stdin = io::stdin(); // 我们在这里得到 `Stdin`。
    {
        let mut handle = stdin.lock(); // 我们在这里得到 `StdinLock`。
        handle.read_line(&mut buffer)?;
    } // `StdinLock` 被丢弃在这里。
    Ok(())
}

Trait Implementations

impl<'a> AsFd for StdinLock<'a>

as_fd

借用文件描述符。

rust
fn as_fd(&self) -> BorrowedFd<'_>

impl<'a> AsHandle for StdinLock<'a>

Available on Windows only.

as_handle

借用句柄。

rust
fn as_handle(&self) -> BorrowedHandle<'_>

impl<'a> AsRawFd for StdinLock<'a>

as_raw_fd

提取原始文件描述符。

rust
fn as_raw_fd(&self) -> RawFd

impl<'a> AsRawHandle for StdinLock<'a>

Available on Windows only.

as_raw_handle

提取原始句柄。

rust
fn as_raw_handle(&self) -> RawHandle

impl BufRead for StdinLock<'_>

fill_buf

返回内部缓冲区的内容,如果内部缓冲区为空,则使用内部 reader 中的更多数据填充内部缓冲区。

rust
fn fill_buf(&mut self) -> Result<&[u8]>

consume

告诉此缓冲区 amt 字节已从缓冲区中消耗掉,因此在调用 read 时不再应返回它们。

rust
fn consume(&mut self, n: usize)

read_until

将所有字节读入 buf,直到到达定界符 byte 或 EOF。

rust
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>

read_line

读取所有字节直到到达换行符 (0xA 字节),并将它们,追加,到提供的 String 缓冲区。

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

has_data_left

检查底层 Read 是否有任何数据可供读取。

rust
fn has_data_left(&mut self) -> Result<bool>

split

返回对该字节 byte 上的 reader 拆分内容的迭代器。

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

lines

返回此 reader 的各行上的迭代器。

rust
fn lines(self) -> Lines<Self> 
where
  Self: Sized,

impl Debug for StdinLock<'_>

fmt

使用给定的格式化程序格式化该值。

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

impl IsTerminal for StdinLock<'_>

is_terminal

如果 descriptor/handle 引用 terminal/tty,则返回 true。

rust
fn is_terminal(&self) -> bool

impl Read for StdinLock<'_>

read

从该源中提取一些字节到指定的缓冲区中,返回读取的字节数。

rust
fn read(&mut self, buf: &mut [u8]) -> Result<usize>

read_buf

从此源中提取一些字节到指定的缓冲区中。

rust
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()>

read_vectored

与 read 相似,不同之处在于它读入缓冲区的一部分。

rust
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

is_read_vectored

确定此 Read 是否具有有效的 read_vectored 实现。

rust
fn is_read_vectored(&self) -> bool

read_to_end

读取所有字节,直到此源中的 EOF 为止,然后将它们放入 buf。

rust
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

read_to_string

读取这个源中的所有字节,直到 EOF 为止,然后将它们追加到 buf。

rust
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

read_exact

读取填充 buf 所需的确切字节数。

rust
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

read_buf_exact

读取填充 cursor 所需的确切字节数。

rust
 fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>

by_ref

为这个 Read 实例创建一个 “by reference” 适配器。

rust
fn by_ref(&mut self) -> &mut Self
where
  Self: Sized,

bytes

将此 Read 实例的字节数转换为 Iterator。

rust
fn bytes(self) -> Bytes<Self>
where
  Self: Sized,

chain

创建一个适配器,将这个流与另一个链接起来。

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

take

创建一个适配器,最多从中读取 limit 个字节。

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

Auto Trait Implementations

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

impl<T> Any for T

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

impl<T> Borrow<T> for T

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

impl<T> BorrowMut<T> for T

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

impl<T> From<T> for T

impl<T, U> Into<U> for T

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

impl<T, U> TryFrom<U> for T

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

impl<T, U> TryInto<U> for T

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

MIT Licensed