Struct cap_async_std::net::TcpStream

[+] Show declaration

pub struct TcpStream { /* fields omitted */ }

[−] Expand description

A TCP stream between a local and a remote socket.

This corresponds to async_std::net::TcpStream.

Note that this TcpStream has no connect method. To create a TcpStream, you must first obtain a Catalog permitting the address, and then call Catalog::connect_tcp_stream.

Implementations

impl TcpStream[−]

pub unsafe fn from_std(std: TcpStream) -> Self[−]

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

Safety

async_std::net::TcpStream is not sandboxed and may access any address that the host process has access to.

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 AsRawFd for TcpStream[+]

[+] Show hidden undocumented items

pub fn as_raw_fd(&self) -> RawFd[−]

Extracts the raw file descriptor.

impl AsyncRead for TcpStream[+]

[+] Show hidden undocumented items

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

Attempt to read from the AsyncRead into buf.

pub 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[+]

[+] Show hidden undocumented items

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

Attempt to read from the AsyncRead into buf.

pub 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[+]

[+] Show hidden undocumented items

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

Attempt to write bytes from buf into the object.

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

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

Attempt to close the object.

pub 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[+]

[+] Show hidden undocumented items

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

Attempt to write bytes from buf into the object.

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

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

Attempt to close the object.

pub 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 FromRawFd for TcpStream[+]

[+] Show hidden undocumented items

pub unsafe fn from_raw_fd(fd: RawFd) -> Self[−]

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for TcpStream[+]

[+] Show hidden undocumented items

pub fn into_raw_fd(self) -> RawFd[−]

Consumes this object, returning the raw underlying file descriptor.