Struct TcpWriter

pub struct TcpWriter<'a> { /* private fields */ }

Available on crate feature tcp only.

The writer half of a TCP socket.

Implementations

impl<'a> TcpWriter<'a>

pub fn wait_write_ready(&self) -> impl Future<Output = ()>

Wait until the socket becomes writable.

A socket becomes writable when the transmit half of the full-duplex connection is open (see may_send()), and the transmit buffer is not full.

This is the equivalent of write, without sending any data.

pub fn write<'s>( &'s mut self, buf: &'s [u8], ) -> impl Future<Output = Result<usize, Error>> + 's

Write data to the socket.

Returns how many bytes were written, or an error. If the socket is not ready to accept data, it waits until it is.

pub fn flush(&mut self) -> impl Future<Output = Result<(), Error>>

Flushes the written data to the socket.

This waits until all data has been sent, and ACKed by the remote host. For a connection closed with abort() it will wait for the TCP RST packet to be sent.

pub async fn write_with<F, R>(&mut self, f: F) -> Result<R, Error>

where F: FnOnce(&mut [u8]) -> (usize, R),

Call f with the largest contiguous slice of octets in the transmit buffer, and enqueue the amount of elements returned by f.

If the socket is not ready to accept data, it waits until it is.

pub fn send_capacity(&self) -> usize

Return the maximum number of bytes inside the transmit buffer.

pub fn send_queue(&self) -> usize

Return the amount of octets queued in the transmit buffer.

Trait Implementations

impl<'d> ErrorType for TcpWriter<'d>

type Error = Error

Error type of all the IO operations on this type.

impl<'d> Write for TcpWriter<'d>

async fn write( &mut self, buf: &[u8], ) -> Result<usize, <TcpWriter<'d> as ErrorType>::Error>

Write a buffer into this writer, returning how many bytes were written.

async fn flush(&mut self) -> Result<(), <TcpWriter<'d> as ErrorType>::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer.

impl<'d> WriteReady for TcpWriter<'d>

fn write_ready(&mut self) -> Result<bool, <TcpWriter<'d> as ErrorType>::Error>

Get whether the writer is ready for immediately writing.