Struct WriteHalf 

pub struct WriteHalf { /* private fields */ }

The writing end of one side. Dropping it without WriteHalf::finish resets the direction, as a dropped socket would.

Implementations

impl WriteHalf

pub fn id(&self) -> StreamId

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

Write what fits now; Error::WouldBlock when the ring is full.

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

Write the complete buffer atomically. When it does not all fit, returns Error::WouldBlock without publishing a prefix.

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

Park until something fits, then write it. Blocks the thread.

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

Write everything, waiting as needed. A failure part-way has already committed a prefix; nothing is replayed.

pub fn finish(&mut self) -> Result<()>

No more bytes from this side (FIN); what is buffered still reaches the reader, then it sees a clean end. The other direction is unaffected. AsyncWriteExt::shutdown does the same.

pub fn reset(&mut self)

Abandon the direction: the reader gets an error and buffered bytes are discarded.

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

The same wait, bounded: false is the timeout and nothing else, which is how a caller with a deadline of its own gives up without giving up its stream.

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

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

pub fn wait_writable_exact(&self, needed: usize) -> Result<()>

Park until an atomic write of needed bytes can be attempted.

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

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

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

Task readiness for an indivisible write of needed bytes.

Trait Implementations

impl Drop for WriteHalf

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.