Struct TcpStream

pub struct TcpStream { /* private fields */ }

A TCP stream between a local and a remote socket.

This corresponds to async_std::net::TcpStream.

This TcpStream has no connect method. To create a TcpStream, first obtain a Pool permitting the address, and then call Pool::connect_tcp_stream.

Implementations

impl TcpStream

pub fn from_std(std: TcpStream) -> Self

Constructs a new instance of Self from the given async_std::net::TcpStream.

This grants access the resources the async_std::net::TcpStream instance already has access to.

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

Returns the remote address that this stream is connected to.

This corresponds to async_std::net::TcpStream::peer_addr.

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

Returns the local socket address of this listener.

This corresponds to async_std::net::TcpStream::local_addr.

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

Shuts down the read, write, or both halves of this connection.

This corresponds to async_std::net::TcpStream::shutdown.

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

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue.

This corresponds to async_std::net::TcpStream::peek.

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

Sets the value of the TCP_NODELAY option on this socket.

This corresponds to async_std::net::TcpStream::set_nodelay.

pub fn nodelay(&self) -> Result<bool>

Gets the value of the TCP_NODELAY option on this socket.

This corresponds to async_std::net::TcpStream::nodelay.

pub fn set_ttl(&self, ttl: u32) -> Result<()>

Sets the value for the IP_TTL option on this socket.

This corresponds to async_std::net::TcpStream::set_ttl.

pub fn ttl(&self) -> Result<u32>

Gets the value of the IP_TTL option for this socket.

This corresponds to async_std::net::TcpStream::ttl.

Trait Implementations

impl AsHandleOrSocket for TcpStream

fn as_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_>

Like AsHandle::as_handle and AsSocket::as_socket but can return either type.

impl AsRawHandleOrSocket for TcpStream

fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket

Like AsRawHandle::as_raw_handle and AsRawSocket::as_raw_socket but can return either type.

impl AsRawSocket for TcpStream

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket.

impl AsSocket for TcpStream

fn as_socket(&self) -> BorrowedSocket<'_>

Borrows the socket.

impl Clone for TcpStream

fn clone(&self) -> TcpStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl From<OwnedSocket> for TcpStream

fn from(socket: OwnedSocket) -> Self

Converts to this type from the input type.

impl From<TcpStream> for OwnedHandleOrSocket

fn from(stream: TcpStream) -> Self

Converts to this type from the input type.

impl From<TcpStream> for OwnedSocket

fn from(stream: TcpStream) -> OwnedSocket

Converts to this type from the input type.

impl FromRawSocket for TcpStream

unsafe fn from_raw_socket(socket: RawSocket) -> Self

Constructs a new I/O object from the specified raw socket.

impl IntoRawHandleOrSocket for TcpStream

fn into_raw_handle_or_socket(self) -> RawHandleOrSocket

Like IntoRawHandle::into_raw_handle and IntoRawSocket::into_raw_socket but can return either type.

impl IntoRawSocket for TcpStream

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.

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>>

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

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>>

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>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, cx: &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>>

Attempt to write bytes from bufs into the object 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>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, cx: &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>>

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

impl SocketlikeViewType for TcpStream