Struct async_net::unix::UnixListener

pub struct UnixListener { /* private fields */ }

A Unix server, listening for connections.

After creating a UnixListener by binding it to an address, it listens for incoming connections. These can be accepted by calling accept() or by awaiting items from the async stream of incoming connections.

Cloning a UnixListener creates another handle to the same socket. The socket will be closed when all handles to it are dropped.

Examples

use async_net::unix::UnixListener;
use futures_lite::prelude::*;

let listener = UnixListener::bind("/tmp/socket")?;
let mut incoming = listener.incoming();

while let Some(stream) = incoming.next().await {
    let mut stream = stream?;
    stream.write_all(b"hello").await?;
}

Implementations

impl UnixListener

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

Creates a new UnixListener bound to the given path.

Examples

use async_net::unix::UnixListener;
use futures_lite::prelude::*;

let listener = UnixListener::bind("/tmp/socket")?;
let mut incoming = listener.incoming();

while let Some(stream) = incoming.next().await {
    let mut stream = stream?;
    stream.write_all(b"hello").await?;
}

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

Accepts a new incoming connection.

Returns a TCP stream and the address it is connected to.

Examples

use async_net::unix::UnixListener;

let listener = UnixListener::bind("/tmp/socket")?;
let (stream, addr) = listener.accept().await?;

pub fn incoming(&self) -> Incoming<'_>

Returns a stream of incoming connections.

Iterating over this stream is equivalent to calling accept() in a loop. The stream of connections is infinite, i.e awaiting the next connection will never result in None.

Examples

use async_net::unix::UnixListener;
use futures_lite::prelude::*;

let listener = UnixListener::bind("/tmp/socket")?;
let mut incoming = listener.incoming();

while let Some(stream) = incoming.next().await {
    let mut stream = stream?;
    stream.write_all(b"hello").await?;
}

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

Returns the local address this listener is bound to.

Examples

use async_net::unix::UnixListener;

let listener = UnixListener::bind("/tmp/socket")?;
println!("Local address is {:?}", listener.local_addr()?);

Trait Implementations

impl AsFd for UnixListener

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Clone for UnixListener

fn clone(&self) -> UnixListener

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl From<Async<UnixListener>> for UnixListener

fn from(listener: Async<UnixListener>) -> UnixListener

Converts to this type from the input type.

impl From<UnixListener> for Arc<Async<UnixListener>>

fn from(val: UnixListener) -> Self

Converts to this type from the input type.

impl TryFrom<OwnedFd> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UnixListener> for UnixListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from(listener: UnixListener) -> Result<UnixListener>

Performs the conversion.