Struct base::sys::linux::UnlinkUnixListener

pub struct UnlinkUnixListener(pub UnixListener);

Used to attempt to clean up a named pipe after it is no longer used.

Tuple Fields

0: UnixListener

Methods from Deref<Target = UnixListener>

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

Accepts a new incoming connection to this listener.

This function will block the calling thread until a new Unix connection is established. When established, the corresponding UnixStream and the remote peer’s address will be returned.

Examples

use std::os::unix::net::UnixListener;

fn main() -> std::io::Result<()> {
    let listener = UnixListener::bind("/path/to/the/socket")?;

    match listener.accept() {
        Ok((socket, addr)) => println!("Got a client: {addr:?}"),
        Err(e) => println!("accept function failed: {e:?}"),
    }
    Ok(())
}

pub fn try_clone(&self) -> Result<UnixListener, Error>

Creates a new independently owned handle to the underlying socket.

The returned UnixListener is a reference to the same socket that this object references. Both handles can be used to accept incoming connections and options set on one listener will affect the other.

Examples

use std::os::unix::net::UnixListener;

fn main() -> std::io::Result<()> {
    let listener = UnixListener::bind("/path/to/the/socket")?;
    let listener_copy = listener.try_clone().expect("try_clone failed");
    Ok(())
}

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

Returns the local socket address of this listener.

Examples

use std::os::unix::net::UnixListener;

fn main() -> std::io::Result<()> {
    let listener = UnixListener::bind("/path/to/the/socket")?;
    let addr = listener.local_addr().expect("Couldn't get local address");
    Ok(())
}

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), Error>

Moves the socket into or out of nonblocking mode.

This will result in the accept operation becoming nonblocking, i.e., immediately returning from their calls. If the IO operation is successful, Ok is returned and no further action is required. If the IO operation could not be completed and needs to be retried, an error with kind io::ErrorKind::WouldBlock is returned.

Examples

use std::os::unix::net::UnixListener;

fn main() -> std::io::Result<()> {
    let listener = UnixListener::bind("/path/to/the/socket")?;
    listener.set_nonblocking(true).expect("Couldn't set non blocking");
    Ok(())
}

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

Returns the value of the SO_ERROR option.

Examples

use std::os::unix::net::UnixListener;

fn main() -> std::io::Result<()> {
    let listener = UnixListener::bind("/tmp/sock")?;

    if let Ok(Some(err)) = listener.take_error() {
        println!("Got error: {err:?}");
    }
    Ok(())
}

Platform specific

On Redox this always returns None.

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

Returns an iterator over incoming connections.

The iterator will never return None and will also not yield the peer’s SocketAddr structure.

Examples

use std::thread;
use std::os::unix::net::{UnixStream, UnixListener};

fn handle_client(stream: UnixStream) {
    // ...
}

fn main() -> std::io::Result<()> {
    let listener = UnixListener::bind("/path/to/the/socket")?;

    for stream in listener.incoming() {
        match stream {
            Ok(stream) => {
                thread::spawn(|| handle_client(stream));
            }
            Err(err) => {
                break;
            }
        }
    }
    Ok(())
}

Trait Implementations

impl AsRef<UnixListener> for UnlinkUnixListener

fn as_ref(&self) -> &UnixListener

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for UnlinkUnixListener

type Target = UnixListener

The resulting type after dereferencing.

fn deref(&self) -> &UnixListener

Dereferences the value.

impl Drop for UnlinkUnixListener

fn drop(&mut self)

Executes the destructor for this type.