Struct tokio::net::unix::UnixListener

pub struct UnixListener { /* fields omitted */ }

A Unix socket which can accept connections from other Unix sockets.

Methods

impl UnixListener

pub fn bind<P>(path: P) -> Result<UnixListener, Error> where
    P: AsRef<Path>, 

Creates a new UnixListener bound to the specified path.

pub fn from_std(
    listener: UnixListener,
    handle: &Handle
) -> Result<UnixListener, Error>

Consumes a UnixListener in the standard library and returns a nonblocking UnixListener from this crate.

The returned listener will be associated with the given event loop specified by handle and is ready to perform I/O.

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

Returns the local socket address of this listener.

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

Returns the value of the SO_ERROR option.

pub fn accept(
    &'_ mut self
) -> impl Future<Output = Result<(UnixStream, SocketAddr), Error>>

Accepts a new incoming connection to this listener.

pub fn incoming(self) -> Incoming

Consumes this listener, returning a stream of the sockets this listener accepts.

This method returns an implementation of the Stream trait which resolves to the sockets the are accepted on this listener.

Trait Implementations

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl TryFrom<UnixListener> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from(stream: UnixListener) -> Result<UnixListener, Error>

Consumes stream, returning the tokio I/O object.

This is equivalent to UnixListener::from_std(stream, &Handle::default()).