结构体 ReadHalf 

pub struct ReadHalf<'a>(/* private fields */);

TcpStream 的 borrowed 读半部，由 split 创建。

从 ReadHalf 读取通常通过 AsyncReadExt trait 上的便捷方法来完成。

实现

impl ReadHalf<'_>

pub fn poll_peek( &mut self, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<usize>>

尝试在套接字上接收数据，但不会从队列中移除该数据。如果数据尚不可用，则注册当前任务以便稍后唤醒。

请注意，对于 poll_peek 或 poll_read 的多次调用，仅会调度传递给最近一次调用的 Context 中的 Waker 接收唤醒。

更多详细信息，请参阅 TcpStream::poll_peek 级别的文档。

示例

use tokio::io::{self, ReadBuf};
use tokio::net::TcpStream;

use std::future::poll_fn;

#[tokio::main]
async fn main() -> io::Result<()> {
    let mut stream = TcpStream::connect("127.0.0.1:8000").await?;
    let (mut read_half, _) = stream.split();
    let mut buf = [0; 10];
    let mut buf = ReadBuf::new(&mut buf);

    poll_fn(|cx| {
        read_half.poll_peek(cx, &mut buf)
    }).await?;

    Ok(())
}

pub async fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

从套接字所连接的远端地址接收数据，但不会从队列中移除该数据。成功时返回已窥视的字节数。

更多详细信息，请参阅 TcpStream::peek 级别的文档。

示例

use tokio::net::TcpStream;
use tokio::io::AsyncReadExt;
use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    // Connect to a peer
    let mut stream = TcpStream::connect("127.0.0.1:8080").await?;
    let (mut read_half, _) = stream.split();

    let mut b1 = [0; 10];
    let mut b2 = [0; 10];

    // Peek at the data
    let n = read_half.peek(&mut b1).await?;

    // Read the data
    assert_eq!(n, read_half.read(&mut b2[..n]).await?);
    assert_eq!(&b1[..n], &b2[..n]);

    Ok(())
}

read 方法定义在 AsyncReadExt trait 上。

pub async fn ready(&self, interest: Interest) -> Result<Ready>

等待任意一个所请求的就绪状态。

该函数通常与 try_read() 配合使用。它也可代替 readable() 来检查返回的就绪集合中是否包含 Ready::READABLE 和 Ready::READ_CLOSED 事件。

函数可能在套接字尚未就绪时完成。这是误报情况，尝试进行操作时将返回 io::ErrorKind::WouldBlock。函数也可能返回空的 Ready 集合，因此应始终检查返回值，若请求的状态尚未设置则可能需要再次等待。

该函数等同于 TcpStream::ready。

Cancel safety

此方法可安全取消。一旦就绪事件发生，该方法将持续立即返回，直到就绪事件被尝试进行读取或写入（且失败返回 WouldBlock 或 Poll::Pending）的操作消耗。

pub async fn readable(&self) -> Result<()>

等待套接字变为可读。

该函数等同于 ready(Interest::READABLE)，通常与 try_read() 配合使用。

该函数也等同于 TcpStream::ready。

Cancel safety

此方法可安全取消。一旦就绪事件发生，该方法将持续立即返回，直到就绪事件被尝试进行读取（且失败返回 WouldBlock 或 Poll::Pending）的操作消耗。

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

尝试从流读取数据到所提供的缓冲区中，返回读取的字节数。

从套接字接收任何已有数据，但不会等待新数据的到达。成功时返回已读取的字节数。由于 try_read() 是非阻塞的，缓冲区不必由异步任务持有，可以完全存在于栈上。

通常，readable() 或 ready() 与该函数配合使用。

Return

如果成功读取数据，则返回 Ok(n)，其中 n 是已读取的字节数。如果 n 为 0，则可能表示以下两种情况之一：

1. The stream’s read half is closed and will no longer yield data.
2. The specified buffer was 0 bytes in length.

如果流尚未准备好读取数据，则返回 Err(io::ErrorKind::WouldBlock)。

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

尝试从流读取数据到所提供的缓冲区中，返回读取的字节数。

数据依次拷贝填充到每个缓冲区中，最后一个缓冲区可能只被部分填充。此方法等效于对拼接后的缓冲区进行一次 try_read() 调用。

从套接字接收任何已有数据，但不会等待新数据的到达。成功时返回已读取的字节数。由于 try_read_vectored() 是非阻塞的，缓冲区不必由异步任务持有，可以完全存在于栈上。

通常，readable() 或 ready() 与该函数配合使用。

Return

如果成功读取数据，则返回 Ok(n)，其中 n 是已读取的字节数。Ok(0) 表示流的读半部已关闭，并且不再产生数据。如果流尚未准备好读取数据，则返回 Err(io::ErrorKind::WouldBlock)。

pub fn try_read_buf<B: BufMut>(&self, buf: &mut B) -> Result<usize>

尝试从流读取数据到所提供的缓冲区中，并推进缓冲区的内部游标，返回读取的字节数。

从套接字接收任何已有数据，但不会等待新数据的到达。成功时返回已读取的字节数。由于 try_read_buf() 是非阻塞的，缓冲区不必由异步任务持有，可以完全存在于栈上。

通常，readable() 或 ready() 与该函数配合使用。

Return

如果成功读取数据，则返回 Ok(n)，其中 n 是已读取的字节数。Ok(0) 表示流的读半部已关闭，并且不再产生数据。如果流尚未准备好读取数据，则返回 Err(io::ErrorKind::WouldBlock)。

pub fn peer_addr(&self) -> Result<SocketAddr>

返回该流连接到的远端地址。

pub fn local_addr(&self) -> Result<SocketAddr>

返回该流绑定的本地地址。

Trait 实现

impl AsRef<TcpStream> for ReadHalf<'_>

fn as_ref(&self) -> &TcpStream

将此类型转换为输入类型的共享引用（通常自动推导）。

impl AsyncRead for ReadHalf<'_>

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

Attempts to read from the AsyncRead into buf. 更多信息

impl<'a> Debug for ReadHalf<'a>

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

使用给定的格式化器格式化此值。 更多信息