Struct TcpStream

pub struct TcpStream { /* private fields */ }

TcpStream

Implementations

impl TcpStream

pub async fn connect<A: ToSocketAddrs>(addr: A) -> Result<Self>

Open a TCP connection to a remote host. Note: This function may block the current thread while resolution is performed.

pub async fn connect_addr(addr: SocketAddr) -> Result<Self>

Establish a connection to the specified addr.

pub async fn connect_addr_with_config( addr: SocketAddr, opts: &TcpConnectOpts, ) -> Result<Self>

Establish a connection to the specified addr with given config.

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

Return the local address that this stream is bound to.

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

Return the remote address that this stream is connected to.

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

Get the value of the TCP_NODELAY option on this socket.

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

Set the value of the TCP_NODELAY option on this socket.

pub fn set_tcp_keepalive( &self, time: Option<Duration>, interval: Option<Duration>, retries: Option<u32>, ) -> Result<()>

Set the value of the SO_KEEPALIVE option on this socket.

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

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

pub async fn readable(&self, relaxed: bool) -> Result<()>

Wait for read readiness. Note: Do not use it before every io. It is different from other runtimes!

Everytime call to this method may pay a syscall cost. In uring impl, it will push a PollAdd op; in epoll impl, it will use use inner readiness state; if !relaxed, it will call syscall poll after that.

If relaxed, on legacy driver it may return false positive result. If you want to do io by your own, you must maintain io readiness and wait for io ready with relaxed=false.

pub async fn writable(&self, relaxed: bool) -> Result<()>

Wait for write readiness. Note: Do not use it before every io. It is different from other runtimes!

Everytime call to this method may pay a syscall cost. In uring impl, it will push a PollAdd op; in epoll impl, it will use use inner readiness state; if !relaxed, it will call syscall poll after that.

If relaxed, on legacy driver it may return false positive result. If you want to do io by your own, you must maintain io readiness and wait for io ready with relaxed=false.

impl TcpStream

pub fn try_into_poll_io(self) -> Result<TcpStreamPoll, (Error, TcpStream)>

Convert to poll-io style TcpStreamPoll

Trait Implementations

impl AsRawFd for TcpStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsReadFd for TcpStream

fn as_reader_fd(&mut self) -> &SharedFdWrapper

Get fd.

impl AsWriteFd for TcpStream

fn as_writer_fd(&mut self) -> &SharedFdWrapper

Get fd.

impl AsyncReadRent for TcpStream

fn read<T: IoBufMut>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Reads bytes from this source into the provided buffer, returning the number of bytes read.

fn readv<T: IoVecBufMut>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Similar to read, but reads data into a slice of buffers.

impl AsyncWriteRent for TcpStream

fn write<T: IoBuf>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Writes the contents of a buffer into this writer, returning the number of bytes written.

fn writev<T: IoVecBuf>( &mut self, buf_vec: T, ) -> impl Future<Output = BufResult<usize, T>>

This function attempts to write the entire contents of buf_vec, but the write may not fully succeed, and it might also result in an error. The bytes will be written starting at the specified offset.

fn flush(&mut self) -> impl Future<Output = Result<()>>

Flushes this output stream, ensuring that all buffered content is successfully written to its destination.

fn shutdown(&mut self) -> impl Future<Output = Result<()>>

Shuts down the output stream, ensuring that the value can be cleanly dropped.

impl CancelableAsyncReadRent for TcpStream

async fn cancelable_read<T: IoBufMut>( &mut self, buf: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as read(2)

async fn cancelable_readv<T: IoVecBufMut>( &mut self, buf: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as readv(2)

impl CancelableAsyncWriteRent for TcpStream

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

Same as write(2)

async fn cancelable_writev<T: IoVecBuf>( &mut self, buf_vec: T, c: CancelHandle, ) -> BufResult<usize, T>

Same as writev(2)

async fn cancelable_flush(&mut self, _c: CancelHandle) -> Result<()>

Flush buffered data if needed

fn cancelable_shutdown( &mut self, _c: CancelHandle, ) -> impl Future<Output = Result<()>>

Same as shutdown

impl Debug for TcpStream

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

Formats the value using the given formatter.

impl IntoPollIo for TcpStream

type PollIo = TcpStreamPoll

The poll-based io type.

fn try_into_poll_io(self) -> Result<Self::PollIo, (Error, Self)>

Convert a completion-based io to a poll-based io(able to get comp_io back).

fn into_poll_io(self) -> Result<Self::PollIo>

Convert a completion-based io to a poll-based io.

impl IntoRawFd for TcpStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Split for TcpStream

TcpStream is safe to split to two parts