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 TcpStream::connect method, or by super::TcpListener::accepting a connection from a super::TcpListener.

Reading and writing to a TcpStream is usually done by using the crate::io::Read and crate::io::Write traits.

Implementations

impl TcpStream

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

Opens a TCP connection to a remote host at the specified address.

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

Returns the local address that this stream is bound to.

pub fn take_error(&self) -> Result<Option<Error>>

Returns the value of the SO_ERROR option.

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

Returns the remote address that this stream is connected to.

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

Gets the value of the TCP_NODELAY option on this socket.

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

Sets the value of the TCP_NODELAY option on this socket.

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. On success, returns the number of bytes read.

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

Gets the value of the IP_TTL option on this socket.

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

Sets the value of the IP_TTL option on this socket.

Trait Implementations

impl AsFd for TcpStream

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 Debug for TcpStream

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

Formats the value using the given formatter.

impl From<TcpStream> for TcpStream

fn from(stream: TcpStream) -> Self

Converts to this type from the input type.

impl Read for TcpStream

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

Reads data from the stream into the provided buffer.

fn read_vectored( &mut self, bufs: &mut [IoSliceMut<'_>], ) -> impl Future<Output = Result<usize>>

fn is_read_vectored(&self) -> bool

fn read_to_end( &mut self, buf: &mut Vec<u8>, ) -> impl Future<Output = Result<usize>>

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

fn read_exact(&mut self, buf: &mut [u8]) -> impl Future<Output = Result<()>>

impl Unwrap for TcpStream

type StdImpl = TcpStream

type TokioImpl = TcpStream

fn unwrap_std(self) -> Self::StdImpl

Unwraps the std underlying implementation of the MaybeFut type.

fn unwrap_tokio(self) -> Self::TokioImpl

Unwraps the tokio underlying implementation of the MaybeFut type.

fn unwrap_std_ref(&self) -> &Self::StdImpl

Unwraps the std underlying implementation of the MaybeFut type as a reference.

fn unwrap_tokio_ref(&self) -> &Self::TokioImpl

Unwraps the tokio underlying implementation of the MaybeFut type as a reference.

fn unwrap_std_mut(&mut self) -> &mut Self::StdImpl

Unwraps the std underlying implementation of the MaybeFut type as a mutable reference.

fn unwrap_tokio_mut(&mut self) -> &mut Self::TokioImpl

Unwraps the tokio underlying implementation of the MaybeFut type as a mutable reference.

fn get_std(self) -> Option<Self::StdImpl>

Safely unwraps the std underlying implementation of the MaybeFut type.

fn get_tokio(self) -> Option<Self::TokioImpl>

Safely unwraps the tokio underlying implementation of the MaybeFut type.

fn get_std_ref(&self) -> Option<&Self::StdImpl>

Safely unwraps the std underlying implementation of the MaybeFut type as a reference.

fn get_tokio_ref(&self) -> Option<&Self::TokioImpl>

Safely unwraps the tokio underlying implementation of the MaybeFut type as a reference.

fn get_std_mut(&mut self) -> Option<&mut Self::StdImpl>

Safely unwraps the std underlying implementation of the MaybeFut type as a mutable reference.

fn get_tokio_mut(&mut self) -> Option<&mut Self::TokioImpl>

Safely unwraps the tokio underlying implementation of the MaybeFut type as a mutable reference.

impl Write for TcpStream

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

Writes a buffer into this writer, returning how many bytes were successfully written.

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

Flushes the output streamer, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored( &mut self, bufs: &[IoSlice<'_>], ) -> impl Future<Output = Result<usize>>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> impl Future<Output = Result<()>>

Attempts to write an entire buffer into this writer.