Struct TcpStream

pub struct TcpStream { /* private fields */ }

A single TCP connection.

This type and references to it implement the AsyncRead and AsyncWrite traits. For more on using this type, see the AsyncReadExt and AsyncWriteExt traits.

Implementations

impl TcpStream

pub fn connect_from_raw( socket: impl IntoRawFd, addr: SocketAddr, ) -> Result<TcpConnector>

Creates a new TcpStream connected to a specific socket address from an existing socket descriptor. This function returns a future which resolves to an io::Result<TcpStream>.

pub fn connect(addr: SocketAddr) -> Result<TcpConnector>

Creates a new TcpStream connected to a specific socket address.

This function returns a future which resolves to an io::Result<TcpStream>.

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shuts down the connection, see std::net::TcpStream.shutdown

pub fn std(&self) -> &TcpStream

Returns a reference to the underlying std::net::TcpStream

Methods from Deref<Target = EventedFd<TcpStream>>

pub fn poll_readable(&self, cx: &mut Context<'_>) -> Poll<Result<(), Status>>

Tests to see if this resource is ready to be read from. If it is not, it arranges for the current task to receive a notification when a “readable” signal arrives.

pub fn poll_writable(&self, cx: &mut Context<'_>) -> Poll<Result<(), Status>>

Tests to see if this resource is ready to be written to. If it is not, it arranges for the current task to receive a notification when a “writable” signal arrives.

pub fn as_ref(&self) -> &T

pub fn need_read(&self, cx: &mut Context<'_>)

Arranges for the current task to receive a notification when a “readable” signal arrives.

pub fn need_write(&self, cx: &mut Context<'_>)

Arranges for the current task to receive a notification when a “writable” signal arrives.

pub fn clear(&self)

Clears all incoming signals.

Trait Implementations

impl AsyncRead for TcpStream

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for TcpStream

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_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl Deref for TcpStream

type Target = EventedFd<TcpStream>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.