Struct tokio::net::tcp::OwnedWriteHalf

pub struct OwnedWriteHalf { /* fields omitted */ }

Owned write half of a TcpStream, created by into_split.

Note that in the AsyncWrite implemenation of this type, poll_shutdown will shut down the TCP stream in the write direction.

Dropping the write half will shutdown the write half of the TCP stream.

Writing to an OwnedWriteHalf is usually done using the convenience methods found on the AsyncWriteExt trait. Examples import this trait through the prelude.

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(self)

Drop the write half, but don't issue a TCP shutdown.

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_buf<B: Buf>(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut B
) -> Poll<Result<usize>>

Writes a Buf into this value, returning how many bytes were written.

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.