Struct UnixStream

pub struct UnixStream { /* private fields */ }

A structure representing a connected Unix socket.

This socket can be connected directly with UnixStream::connect or accepted from a listener with UnixListener::incoming. Additionally, a pair of anonymous Unix sockets can be created with UnixStream::pair.

Implementations

impl UnixStream

pub fn connect(path: impl AsRef<Path>) -> ConnectFuture

Connects to the socket named by path.

This function will create a new Unix socket and connect to the path specified, associating the returned stream with the default event loop’s handle.

Examples

use futures_net::UnixStream;

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

pub fn pair() -> Result<(UnixStream, UnixStream)>

Creates an unnamed pair of connected sockets.

This function will create a pair of interconnected Unix sockets for communicating back and forth between one another. Each socket will be associated with the event loop whose handle is also provided.

Examples

use futures_net::UnixStream;

let (sock1, sock2) = UnixStream::pair()?;

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

Returns the socket address of the local half of this connection.

Examples

use futures_net::UnixStream;

let stream = UnixStream::connect("/tmp/sock").await?;
let addr = stream.local_addr()?;

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

Returns the socket address of the remote half of this connection.

Examples

use futures_net::UnixStream;

let stream = UnixStream::connect("/tmp/sock").await?;
let addr = stream.peer_addr()?;

pub fn peer_cred(&self) -> Result<UCred>

Returns effective credentials of the process which called connect or socketpair.

Examples

use futures_net::UnixStream;

let stream = UnixStream::connect("/tmp/sock").await?;
let cred = stream.peer_cred()?;

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

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

This function will cause all pending and future I/O calls on the specified portions to immediately return with an appropriate value (see the documentation of Shutdown).

use futures_net::UnixStream;
use std::net::Shutdown;

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

Trait Implementations

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncRead for UnixStream

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 AsyncReadReady for UnixStream

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

Test whether this socket is ready to be read or not.

type Ok = Ready

The type of successful values yielded by this trait.

type Err = Error

The type of failures yielded by this trait.

fn poll_read_ready_unpin( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Self::Ok, Self::Err>>

where Self: Sized + Unpin,

A convenience for calling AsyncReadReady::poll_read_ready on Unpin types.

impl AsyncWrite for UnixStream

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>, cx: &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 AsyncWriteReady for UnixStream

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

Test whether this socket is ready to be written to or not.

type Ok = Ready

The type of successful values yielded by this trait.

type Err = Error

The type of failures yielded by this trait.

fn poll_write_ready_unpin( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Self::Ok, Self::Err>>

where Self: Sized + Unpin,

A convenience for calling AsyncWriteReady::poll_write_ready on Unpin types.

impl Debug for UnixStream

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

Formats the value using the given formatter.

impl TakeError for UnixStream

fn take_error(&self) -> Result<Option<Self::Ok>, Self::Err>

Returns the value of the SO_ERROR option.

Examples

use futures_net::UnixStream;
use async_ready::TakeError;

let stream = UnixStream::connect("/tmp/sock").await?;
if let Ok(Some(err)) = stream.take_error() {
    println!("Got error: {:?}", err);
}

type Ok = Error

The type of successful values yielded by this trait.

type Err = Error

The type of failures yielded by this trait.

impl Unpin for UnixStream