Struct tokio::net::tcp::WriteHalf

pub struct WriteHalf<'a>(_);

Borrowed write half of a TcpStream, created by split.

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

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

Trait Implementations

impl AsRef<TcpStream> for WriteHalf<'_>

fn as_ref(&self) -> &TcpStream

Performs the conversion.

impl AsyncWrite for WriteHalf<'_>

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<'a> Debug for WriteHalf<'a>

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

Formats the value using the given formatter.