Struct async_net::unix::UnixStream

[+] Show declaration

pub struct UnixStream { /* fields omitted */ }

[−] Expand description

A Unix connection.

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

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

Cloning a UnixStream 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.

Examples

use async_net::unix::UnixStream;
use futures_lite::*;

let mut stream = UnixStream::connect("/tmp/socket").await?;
stream.write_all(b"hello").await?;

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

Implementations

impl UnixStream[−]

pub async fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>[−]

Creates a Unix connection to given path.

Examples

use async_net::unix::UnixStream;

let stream = UnixStream::connect("/tmp/socket").await?;

pub fn pair() -> Result<(UnixStream, UnixStream)>[−]

Creates a pair of connected Unix sockets.

Examples

use async_net::unix::UnixStream;

let (stream1, stream2) = UnixStream::pair()?;

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

Returns the local address this socket is connected to.

Examples

use async_net::unix::UnixStream;

let stream = UnixStream::connect("/tmp/socket").await?;
println!("Local address is {:?}", stream.local_addr()?);

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

Returns the remote address this socket is connected to.

Examples

use async_net::unix::UnixStream;

let stream = UnixStream::connect("/tmp/socket").await?;
println!("Connected to {:?}", stream.peer_addr()?);

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).

use async_net::{Shutdown, unix::UnixStream};

let stream = UnixStream::connect("/tmp/socket").await?;
stream.shutdown(Shutdown::Both)?;

Trait Implementations

impl AsRawFd for UnixStream[+]

[+] Show hidden undocumented items

fn as_raw_fd(&self) -> RawFd[−]

Extracts the raw file descriptor.

impl AsyncRead for UnixStream[+]

[+] Show hidden undocumented items

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

Attempt to read from the AsyncRead into buf.

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.

impl AsyncWrite for UnixStream[+]

[+] Show hidden undocumented items

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

Attempt to write bytes from buf into the object.

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.

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Clone for UnixStream[+]

[+] Show hidden undocumented items

fn clone(&self) -> UnixStream[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for UnixStream[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl From<Async<UnixStream>> for UnixStream[+]

[+] Show hidden undocumented items

fn from(stream: Async<UnixStream>) -> UnixStream[−]

Performs the conversion.

impl RefUnwindSafe for UnixStream

impl TryFrom<UnixStream> for UnixStream[+]

[+] Show hidden undocumented items

type Error = Error

The type returned in the event of a conversion error.

fn try_from(stream: UnixStream) -> Result<UnixStream>[−]

Performs the conversion.

impl UnwindSafe for UnixStream