Struct ConnectionWriter 

pub struct ConnectionWriter { /* private fields */ }

An interface to write messages to the network connection.

Implements the Sink trait to asynchronously write messages to the network connection.

Example

Basic usage:

writer.send(msg).await?;

Please see the tcp-client example program or other client example programs for a more thorough showcase.

Implementations

impl ConnectionWriter

pub fn new( local_addr: SocketAddr, peer_addr: SocketAddr, write_stream: Pin<Box<dyn AsyncWrite + Send + Sync>>, ) -> Self

Creates a new ConnectionWriter from an AsyncWrite trait object and the local and peer socket metadata.

pub fn local_addr(&self) -> SocketAddr

Get the local IP address and port.

pub fn peer_addr(&self) -> SocketAddr

Get the peer IP address and port.

pub fn is_closed(&self) -> bool

Check if the Sink of messages to the network is closed.

Trait Implementations

impl Sink<ConnectDatagram> for ConnectionWriter

type Error = ConnectionWriteError

The type of value produced by the sink when an error occurs.

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

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: ConnectDatagram, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

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

Flush any remaining output from this sink.

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

Flush any remaining output and close this sink, if necessary.