Struct tokio::io::ReadHalf

pub struct ReadHalf<T> { /* fields omitted */ }

This is supported on feature="io-util" only.

The readable half of a value returned from split.

Methods

impl<T> ReadHalf<T>

pub fn is_pair_of(&self, other: &WriteHalf<T>) -> bool

This is supported on feature="io-util" only.

Checks if this ReadHalf and some WriteHalf were split from the same stream.

pub fn unsplit(self, wr: WriteHalf<T>) -> T

This is supported on feature="io-util" only.

Reunites with a previously split WriteHalf.

Panics

If this ReadHalf and the given WriteHalf do not originate from the same split operation this method will panic. This can be checked ahead of time by comparing the stream ID of the two halves.

Trait Implementations

impl<T: AsyncRead> AsyncRead for ReadHalf<T>

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

Attempts to read from the AsyncRead into buf.

fn poll_read_buf<B: BufMut>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize>>

Pulls some bytes from this source into the specified BufMut, returning how many bytes were read.

unsafe fn prepare_uninitialized_buffer(
    &self,
    buf: &mut [MaybeUninit<u8>]
) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

impl<T: Debug> Debug for ReadHalf<T>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Send> Send for ReadHalf<T>

impl<T: Sync> Sync for ReadHalf<T>