Struct async_net::TcpStream

source · [−]

pub struct TcpStream { /* private fields */ }

Expand description

A TCP connection.

A TcpStream can be created by connecting to an endpoint or by accepting an incoming connection.

TcpStream is a bidirectional stream that implements traits AsyncRead and AsyncWrite.

Cloning a TcpStream creates another handle to the same socket. The socket will be closed when all handles to it are dropped. The reading and writing portions of the connection can also be shut down individually with the shutdown() method.

The Transmission Control Protocol is specified in IETF RFC 793.

Examples

use async_net::TcpStream;
use futures_lite::prelude::*;

let mut stream = TcpStream::connect("127.0.0.1:8080").await?;
stream.write_all(b"hello").await?;

let mut buf = vec![0u8; 1024];
let n = stream.read(&mut buf).await?;

Implementations

source

impl TcpStream

source

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

Creates a TCP connection to the specified address.

This method will create a new TCP socket and attempt to connect it to the provided addr,

If addr yields multiple addresses, connecting will be attempted with each of the addresses until connecting to one succeeds. If none of the addresses result in a successful connection, the error from the last connect attempt is returned.

Examples

Connect to example.com:80:

use async_net::TcpStream;

let stream = TcpStream::connect("example.com:80").await?;

Connect to 127.0.0.1:8080. If that fails, then try connecting to 127.0.0.1:8081:

use async_net::{SocketAddr, TcpStream};

let addrs = [
    SocketAddr::from(([127, 0, 0, 1], 8080)),
    SocketAddr::from(([127, 0, 0, 1], 8081)),
];
let stream = TcpStream::connect(&addrs[..]).await?;

source

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

Returns the local address this stream is bound to.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("example.com:80").await?;
println!("Local address is {}", stream.local_addr()?);

source

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

Returns the remote address this stream is connected to.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("example.com:80").await?;
println!("Connected to {}", stream.peer_addr()?);

source

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

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

This method will cause all pending and future I/O in the given directions to return immediately with an appropriate value (see the documentation of Shutdown).

Examples

use async_net::{Shutdown, TcpStream};

let stream = TcpStream::connect("127.0.0.1:8080").await?;
stream.shutdown(Shutdown::Both)?;

source

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

Receives data without removing it from the queue.

On success, returns the number of bytes peeked.

Successive calls return the same data. This is accomplished by passing MSG_PEEK as a flag to the underlying recv system call.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("127.0.0.1:8080").await?;

let mut buf = vec![0; 1024];
let n = stream.peek(&mut buf).await?;

source

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

Gets the value of the TCP_NODELAY option for this socket.

If set to true, this option disables the Nagle algorithm. This means that written data is always sent as soon as possible, even if there is only a small amount of it.

When set to false, written data is buffered until there is a certain amount to send out, thereby avoiding the frequent sending of small packets.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("127.0.0.1:8080").await?;
println!("TCP_NODELAY is set to {}", stream.nodelay()?);

source

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

Sets the value of the TCP_NODELAY option for this socket.

If set to true, this option disables the Nagle algorithm. This means that written data is always sent as soon as possible, even if there is only a small amount of it.

When set to false, written data is buffered until there is a certain amount to send out, thereby avoiding the frequent sending of small packets.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("127.0.0.1:8080").await?;
stream.set_nodelay(false)?;

source

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

Gets the value of the IP_TTL option for this socket.

This option configures the time-to-live field that is used in every packet sent from this socket.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("127.0.0.1:8080").await?;
println!("IP_TTL is set to {}", stream.ttl()?);

source

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

Sets the value of the IP_TTL option for this socket.

This option configures the time-to-live field that is used in every packet sent from this socket.

Examples

use async_net::TcpStream;

let stream = TcpStream::connect("127.0.0.1:8080").await?;
stream.set_ttl(100)?;

Trait Implementations

source

impl AsRawFd for TcpStream

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl AsyncRead for TcpStream

source

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

Attempt to read from the AsyncRead into buf. Read more

source

fn poll_read_vectored(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

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

source

impl AsyncWrite for TcpStream

source

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

Attempt to write bytes from buf into the object. Read more

source

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. Read more

source

fn poll_close(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object. Read more

source

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. Read more

source

impl Clone for TcpStream

source

fn clone(&self) -> TcpStream

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for TcpStream

source

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

Formats the value using the given formatter. Read more

source

impl From<Async<TcpStream>> for TcpStream

source

fn from(stream: Async<TcpStream>) -> TcpStream

Performs the conversion.

source

impl From<TcpStream> for Arc<Async<TcpStream>>

source

fn from(val: TcpStream) -> Self

Performs the conversion.

source

impl TryFrom<TcpStream> for TcpStream

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(stream: TcpStream) -> Result<TcpStream>

Performs the conversion.

source

impl RefUnwindSafe for TcpStream

source

impl UnwindSafe for TcpStream

Auto Trait Implementations

impl Send for TcpStream

impl Sync for TcpStream

impl Unpin for TcpStream

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

source

fn read(&'a mut self, buf: &'a mut [u8 ]) -> ReadFuture<'a, Self> where
Self: Unpin,

Reads some bytes from the byte stream. Read more

source

fn read_vectored(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
 Self: Unpin,

Like read(), except it reads into a slice of buffers. Read more

source

fn read_to_end(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
 Self: Unpin,

Reads the entire contents and appends them to a Vec. Read more

source

fn read_to_string(
 &'a mut self,
 buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
 Self: Unpin,

Reads the entire contents and appends them to a String. Read more

source

fn read_exact(&'a mut self, buf: &'a mut [u8 ]) -> ReadExactFuture<'a, Self> where
Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

source

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it. Read more

source

fn bytes(self) -> Bytes<Self>

Converts this AsyncRead into a Stream of bytes. Read more

source

fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,

Creates an adapter which will chain this stream with another. Read more

source

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the reader and changes its type to dyn AsyncRead + Send + 'a. Read more

source

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

source

fn write(&'a mut self, buf: &'a [u8 ]) -> WriteFuture<'a, Self> where
Self: Unpin,

Writes some bytes into the byte stream. Read more

source

fn write_vectored(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
 Self: Unpin,

Like write(), except that it writes a slice of buffers. Read more

source

fn write_all(&'a mut self, buf: &'a [u8 ]) -> WriteAllFuture<'a, Self> where
Self: Unpin,

Writes an entire buffer into the byte stream. Read more

source

fn flush(&mut self) -> FlushFuture<'_, Self> where
Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more

source

fn close(&mut self) -> CloseFuture<'_, Self> where
Self: Unpin,

Closes the writer. Read more

source

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct async_net::TcpStream

Implementations

impl TcpStream

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

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

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

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

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

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

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

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

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

Trait Implementations

impl AsRawFd for TcpStream

fn as_raw_fd(&self) -> RawFd

impl AsyncRead for TcpStream

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

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>]) -> Poll<Result<usize, Error>>

impl AsyncWrite for TcpStream

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

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

fn poll_close(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>]) -> Poll<Result<usize>>

impl Clone for TcpStream

fn clone(&self) -> TcpStream

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

impl Debug for TcpStream

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

impl From<Async<TcpStream>> for TcpStream

fn from(stream: Async<TcpStream>) -> TcpStream

impl From<TcpStream> for Arc<Async<TcpStream>>

fn from(val: TcpStream) -> Self

impl TryFrom<TcpStream> for TcpStream

type Error = Error

fn try_from(stream: TcpStream) -> Result<TcpStream>

impl RefUnwindSafe for TcpStream

impl UnwindSafe for TcpStream

Auto Trait Implementations

impl Send for TcpStream

impl Sync for TcpStream

impl Unpin for TcpStream

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for R where R: AsyncRead + ?Sized,

fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self> where Self: Unpin,

fn read_vectored( &'a mut self, bufs: &'a mut [IoSliceMut<'a>]) -> ReadVectoredFuture<'a, Self> where Self: Unpin,

fn read_to_end( &'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEndFuture<'a, Self> where Self: Unpin,

fn read_to_string( &'a mut self, buf: &'a mut String) -> ReadToStringFuture<'a, Self> where Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self> where Self: Unpin,

fn take(self, limit: u64) -> Take<Self>

fn bytes(self) -> Bytes<Self>

fn chain<R>(self, next: R) -> Chain<Self, R> where R: AsyncRead,

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>> where Self: 'a + Send,

impl<W> AsyncWriteExt for W where W: AsyncWrite + ?Sized,

fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self> where Self: Unpin,

fn write_vectored( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectoredFuture<'a, Self> where Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self> where Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self> where Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self> where Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>> where Self: 'a + Send,

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

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

fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>

impl<T> Any for T where
T: 'static + ?Sized,

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

fn read(&'a mut self, buf: &'a mut [u8 ]) -> ReadFuture<'a, Self> where
Self: Unpin,

fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,

fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin,

fn read_to_string(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8 ]) -> ReadExactFuture<'a, Self> where
Self: Unpin,

fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>> where
Self: 'a + Send,

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

fn write(&'a mut self, buf: &'a [u8 ]) -> WriteFuture<'a, Self> where
Self: Unpin,

fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8 ]) -> WriteAllFuture<'a, Self> where
Self: Unpin,

fn flush(&mut self) -> FlushFuture<'_, Self> where
Self: Unpin,

fn close(&mut self) -> CloseFuture<'_, Self> where
Self: Unpin,

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a, Global>> where
Self: 'a + Send,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,