Struct TcpStream

pub struct TcpStream { /* private fields */ }

A TCP stream between a local and a remote socket.

A TCP stream can either be created by connecting to an endpoint, via the connect method, or by accepting a connection from a listener.

Examples

use std::net::SocketAddr;

use compio_io::AsyncWrite;
use compio_net::TcpStream;

// Connect to a peer
let mut stream = TcpStream::connect("127.0.0.1:8080").await.unwrap();

// Write some data.
stream.write("hello world!").await.unwrap();

Implementations

impl TcpStream

pub async fn connect(addr: impl ToSocketAddrsAsync) -> Result<Self>

Opens a TCP connection to a remote host.

pub async fn bind_and_connect( bind_addr: SocketAddr, addr: impl ToSocketAddrsAsync, ) -> Result<Self>

Bind to bind_addr then opens a TCP connection to a remote host.

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

Creates new TcpStream from a std::net::TcpStream.

pub fn close(self) -> impl Future<Output = Result<()>>

Close the socket. If the returned future is dropped before polling, the socket won’t be closed.

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

Returns the socket address of the remote peer of this TCP connection.

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

Returns the socket address of the local half of this TCP connection.

pub fn split(&self) -> (ReadHalf<'_, Self>, WriteHalf<'_, Self>)

Splits a TcpStream into a read half and a write half, which can be used to read and write the stream concurrently.

This method is more efficient than into_split, but the halves cannot be moved into independently spawned tasks.

pub fn into_split(self) -> (OwnedReadHalf<Self>, OwnedWriteHalf<Self>)

Splits a TcpStream into a read half and a write half, which can be used to read and write the stream concurrently.

Unlike split, the owned halves can be moved to separate tasks, however this comes at the cost of a heap allocation.

pub fn to_poll_fd(&self) -> Result<PollFd<Socket2>>

Create PollFd from inner socket.

pub fn into_poll_fd(self) -> Result<PollFd<Socket2>>

Create PollFd from inner socket.

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

Gets the value of the TCP_NODELAY option on this socket.

For more information about this option, see TcpStream::set_nodelay.

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

Sets the value of the TCP_NODELAY option on this socket.

If set, this option disables the Nagle algorithm. This means that segments are always sent as soon as possible, even if there is only a small amount of data. When not set, data is buffered until there is a sufficient amount to send out, thereby avoiding the frequent sending of small packets.

Trait Implementations

impl AsFd for TcpStream

Available on Unix only.

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for TcpStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for &TcpStream

async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V: IoVectoredBufMut>( &mut self, buf: V, ) -> BufResult<usize, V>

Like read, except that it reads into a type implements IoVectoredBufMut.

impl AsyncRead for TcpStream

async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>

Read some bytes from this source into the IoBufMut buffer and return a BufResult, consisting of the buffer and a usize indicating how many bytes were read.

async fn read_vectored<V: IoVectoredBufMut>( &mut self, buf: V, ) -> BufResult<usize, V>

Like read, except that it reads into a type implements IoVectoredBufMut.

impl AsyncReadManaged for &TcpStream

type Buffer<'a> = BorrowedBuffer<'a>

Filled buffer type

type BufferPool = BufferPool

Buffer pool type

async fn read_managed<'a>( &mut self, buffer_pool: &'a Self::BufferPool, len: usize, ) -> Result<Self::Buffer<'a>>

Read some bytes from this source with Self::BufferPool and return a Self::Buffer.

impl AsyncReadManaged for TcpStream

type Buffer<'a> = BorrowedBuffer<'a>

Filled buffer type

type BufferPool = BufferPool

Buffer pool type

async fn read_managed<'a>( &mut self, buffer_pool: &'a Self::BufferPool, len: usize, ) -> Result<Self::Buffer<'a>>

Read some bytes from this source with Self::BufferPool and return a Self::Buffer.

impl AsyncWrite for &TcpStream

async fn write<T: IoBuf>(&mut self, buf: T) -> BufResult<usize, T>

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<T: IoVectoredBuf>( &mut self, buf: T, ) -> BufResult<usize, T>

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

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

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl AsyncWrite for TcpStream

async fn write<T: IoBuf>(&mut self, buf: T) -> BufResult<usize, T>

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<T: IoVectoredBuf>( &mut self, buf: T, ) -> BufResult<usize, T>

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

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

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl Clone for TcpStream

fn clone(&self) -> TcpStream

Returns a duplicate of the value.

const 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 FromRawFd for TcpStream

Available on Unix only.

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl<'a> Splittable for &'a TcpStream

type ReadHalf = ReadHalf<'a, TcpStream>

The type of the read half, which normally implements AsyncRead or AsyncReadAt.

type WriteHalf = WriteHalf<'a, TcpStream>

The type of the write half, which normally implements AsyncWrite or AsyncWriteAt.

fn split(self) -> (Self::ReadHalf, Self::WriteHalf)

Consumes self and returns a tuple containing separate read and write halves.

impl Splittable for TcpStream

type ReadHalf = OwnedReadHalf<TcpStream>

The type of the read half, which normally implements AsyncRead or AsyncReadAt.

type WriteHalf = OwnedWriteHalf<TcpStream>

The type of the write half, which normally implements AsyncWrite or AsyncWriteAt.

fn split(self) -> (Self::ReadHalf, Self::WriteHalf)

Consumes self and returns a tuple containing separate read and write halves.

impl ToSharedFd<Socket> for TcpStream

fn to_shared_fd(&self) -> SharedFd<Socket>

Return a cloned SharedFd.