Struct tokio::net::tcp::OwnedWriteHalf

pub struct OwnedWriteHalf { /* fields omitted */ }

This is supported on crate feature net only.

Owned write half of a TcpStream, created by into_split.

Note that in the AsyncWrite implementation of this type, poll_shutdown will shut down the TCP stream in the write direction. Dropping the write half will also shut down the write half of the TCP stream.

Writing to an OwnedWriteHalf is usually done using the convenience methods found on the AsyncWriteExt trait.

Implementations

impl OwnedWriteHalf

pub fn reunite(self, other: OwnedReadHalf) -> Result<TcpStream, ReuniteError>

Attempts to put the two halves of a TcpStream back together and recover the original socket. Succeeds only if the two halves originated from the same call to into_split.

pub fn forget(mut self: Self)

Destroy the write half, but don't close the write half of the stream until the read half is dropped. If the read half has already been dropped, this closes the stream.

Trait Implementations

impl AsRef<TcpStream> for OwnedWriteHalf

fn as_ref(&self) -> &TcpStream

Performs the conversion.

impl AsyncWrite for OwnedWriteHalf

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

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl Debug for OwnedWriteHalf

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

Formats the value using the given formatter.

impl Drop for OwnedWriteHalf

fn drop(&mut self)

Executes the destructor for this type.