Struct ReadHalf 

pub struct ReadHalf { /* private fields */ }

The reading end of one side. Dropping it tells the peer’s writer that nothing more will be read.

Implementations

impl ReadHalf

pub fn id(&self) -> StreamId

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

Read what is there now. Ok(0) is clean end of stream; Error::WouldBlock means nothing yet.

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

Read the complete buffer atomically. When it is not all available, returns Error::WouldBlock without consuming a prefix.

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

Park until something can be read, then read it. Ok(0) is clean end of stream. Blocks the thread; an async runtime uses AsyncRead.

pub fn blocking_read_chunk(&self, max: usize) -> Result<Bytes>

Up to max bytes as one owned chunk; empty at clean end of stream.

pub fn wait_readable_timeout(&self, timeout: Duration) -> Result<bool>

The same wait, bounded: false is the timeout and nothing else.

pub fn wait_readable(&self) -> Result<()>

Park until a read would make progress or the direction ended.

pub fn poll_readable(&self, cx: &mut Context<'_>) -> Poll<Result<()>>

Readiness for a task: Ready when a read would make progress or the direction ended, otherwise the waker is registered and Pending comes back. Runtime-neutral; the tokio feature builds AsyncRead on it.

Trait Implementations

impl Drop for ReadHalf

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.