Struct Stream 

pub struct Stream { /* private fields */ }

A network stream.

Stream provides an abstraction over connectionless and connection-oriented network sockets. In many cases, it is not required to know the exact socket family (e.g. TCP, UDP, Unix domain socket) that is being used, and it can be beneficial to allow abstracting over the differences to facilitate simpler code.

Connection-oriented mode

In connection-oriented mode, the stream is backed by a socket that operates in a connection-oriented manner, which ensures a reliable, ordered stream of messages to and from the remote peer.

The connection address returned when receiving data should be stable for the life of the Stream.

Connectionless mode

In connectionless mode, the stream is backed by a socket that operates in a connectionless manner, which does not provide any assurances around reliability and ordering of messages to and from the remote peer. While a stream might be backed by a Unix domain socket in datagram mode, which does provide reliability of messages, this cannot and should not be relied upon when using Stream.

Implementations

impl Stream

pub fn is_connectionless(&self) -> bool

Returns true if the stream is connectionless.

pub async fn receive<B: BufMut>( &mut self, buf: &mut B, ) -> Result<(usize, ConnectionAddress)>

Receives data from the stream.

On success, returns the number of bytes read and the address from whence the data came.

Errors

If the underlying system call fails, an error is returned.

Trait Implementations

impl From<(TcpStream, SocketAddr)> for Stream

fn from((stream, remote_addr): (TcpStream, SocketAddr)) -> Self

Converts to this type from the input type.

impl From<UdpSocket> for Stream

fn from(socket: UdpSocket) -> Self

Converts to this type from the input type.

impl From<UnixDatagram> for Stream

Available on Unix only.

fn from(socket: UnixDatagram) -> Self

Converts to this type from the input type.

impl From<UnixStream> for Stream

Available on Unix only.

fn from(stream: UnixStream) -> Self

Converts to this type from the input type.