Struct tokio::net::UnixListener

pub struct UnixListener { /* fields omitted */ }

This is supported on feature="uds" only.

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

Methods

impl UnixListener

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

This is supported on feature="uds" only.

Creates a new UnixListener bound to the specified path.

Panics

This function panics if thread-local runtime is not set.

The runtime is usually set implicitly when this function is called from a future driven by a tokio runtime, otherwise runtime can be set explicitly with Handle::enter function.

pub fn from_std(listener: UnixListener) -> Result<UnixListener>

This is supported on feature="uds" only.

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.

Panics

This function panics if thread-local runtime is not set.

The runtime is usually set implicitly when this function is called from a future driven by a tokio runtime, otherwise runtime can be set explicitly with Handle::enter function.

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

This is supported on feature="uds" only.

Returns the local socket address of this listener.

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

This is supported on feature="uds" only.

Returns the value of the SO_ERROR option.

pub async fn accept<'_>(&'_ mut self) -> Result<(UnixStream, SocketAddr)>

This is supported on feature="uds" only.

Accepts a new incoming connection to this listener.

pub fn incoming(&mut self) -> Incoming

This is supported on feature="uds" only.

Returns a stream over the connections being received on this listener.

The returned stream will never return None and will also not yield the peer's SocketAddr structure. Iterating over it is equivalent to calling accept in a loop.

Errors

Note that accepting a connection can lead to various errors and not all of them are necessarily fatal ‒ for example having too many open file descriptors or the other side closing the connection while it waits in an accept queue. These would terminate the stream if not handled in any way.

Examples

use tokio::net::UnixListener;
use tokio::stream::StreamExt;

#[tokio::main]
async fn main() {
    let mut listener = UnixListener::bind("/path/to/the/socket").unwrap();
    let mut incoming = listener.incoming();

    while let Some(stream) = incoming.next().await {
        match stream {
            Ok(stream) => {
                println!("new client!");
            }
            Err(e) => { /* connection failed */ }
        }
    }
}

Trait Implementations

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl TryFrom<UnixListener> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

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

Consumes value, returning the mio I/O object.

See PollEvented::into_inner for more details about resource deregistration that happens during the call.

impl TryFrom<UnixListener> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from(stream: UnixListener) -> Result<Self>

Consumes stream, returning the tokio I/O object.

This is equivalent to UnixListener::from_std(stream).