Struct TcpStream 

pub struct TcpStream { /* private fields */ }

Native async TCP stream with statistics tracking

Implementations

impl TcpStream

pub async fn connect(addr: &str) -> Result<TcpStream, Error>

Connect to a remote address asynchronously.

addr is a literal socket address or host:port; hostnames resolve off the polling thread (see resolve). Each resolved address is tried in order and the first successful connection is returned. Neither resolution nor the TCP handshake blocks the polling thread, so wrapping this future in crate::timeout() or dropping it bounds the wait.

Errors

Returns the resolution error, or the connect error of the last address tried when none accepts.

pub fn from_std(stream: TcpStream) -> Result<TcpStream, Error>

Wrap an existing TCP stream in the Moirai TCP facade.

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read data from the stream

pub async fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write data to the stream

pub async fn flush(&mut self) -> Result<(), Error>

Flush the stream

pub async fn shutdown(&mut self) -> Result<(), Error>

Shutdown the write side of the stream.

pub fn peer_addr(&self) -> Result<SocketAddr, Error>

Get the peer address

pub fn local_addr(&self) -> Result<SocketAddr, Error>

Get the local address

pub fn set_nodelay(&self, on: bool) -> Result<(), Error>

Configure TCP_NODELAY on the stream.

Trait Implementations

impl AsyncRead for TcpStream

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

Attempt to read from the source into the provided buffer.

impl AsyncWrite for TcpStream

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

Attempt to write bytes from the buffer to the destination.

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

Attempt to flush pending writes.

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

Attempt to close/shutdown the write side of the stream.

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

Attempt to write bytes from several buffers in one operation.

fn is_write_vectored(&self) -> bool

Whether poll_write_vectored is cheaper than one poll_write per buffer.

impl Drop for TcpStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.