Struct async_std::os::unix::net::UnixListener

pub struct UnixListener { /* fields omitted */ }

This is supported on Unix only.

A Unix domain socket server, listening for connections.

After creating a UnixListener by binding it to a socket address, it listens for incoming connections. These can be accepted by awaiting elements from the async stream of incoming connections.

The socket will be closed when the value is dropped.

This type is an async version of std::os::unix::net::UnixListener.

Examples

use async_std::os::unix::net::UnixListener;
use async_std::prelude::*;

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

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

Methods

impl UnixListener

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

This is supported on Unix only.

Creates a Unix datagram listener bound to the given path.

Examples

use async_std::os::unix::net::UnixListener;

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

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

This is supported on Unix only.

Accepts a new incoming connection to this listener.

When a connection is established, the corresponding stream and address will be returned.

Examples

use async_std::os::unix::net::UnixListener;

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

pub fn incoming(&self) -> Incoming

This is supported on Unix only.

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_std::os::unix::net::UnixListener;
use async_std::prelude::*;

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

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

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

This is supported on Unix only.

Returns the local socket address of this listener.

Examples

use async_std::os::unix::net::UnixListener;

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

Trait Implementations

impl AsRawFd for UnixListener

fn as_raw_fd(&self) -> RawFd

This is supported on Unix only.

Extracts the raw file descriptor.

impl FromRawFd for UnixListener

unsafe fn from_raw_fd(fd: RawFd) -> UnixListener

This is supported on Unix only.

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for UnixListener

fn into_raw_fd(self) -> RawFd

This is supported on Unix only.

Consumes this object, returning the raw underlying file descriptor.

impl From<UnixListener> for UnixListener

fn from(listener: UnixListener) -> UnixListener

Converts a std::os::unix::net::UnixListener into its asynchronous equivalent.

impl Debug for UnixListener

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

Formats the value using the given formatter.