Struct std::os::unix::net::UnixListener

pub struct UnixListener(_);

This is supported on Unix only.

A structure representing a Unix domain socket server.

Examples

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

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

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

// accept connections and process them, spawning a new thread for each one
for stream in listener.incoming() {
    match stream {
        Ok(stream) => {
            /* connection succeeded */
            thread::spawn(|| handle_client(stream));
        }
        Err(err) => {
            /* connection failed */
            break;
        }
    }
}

Methods

impl UnixListener

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

This is supported on Unix only.

Creates a new UnixListener bound to the specified socket.

Examples

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

let listener = match UnixListener::bind("/path/to/the/socket") {
    Ok(sock) => sock,
    Err(e) => {
        println!("Couldn't connect: {:?}", e);
        return
    }
};

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

This is supported on Unix only.

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;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

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

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

This is supported on Unix only.

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;

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

let listener_copy = listener.try_clone().expect("try_clone failed");

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

This is supported on Unix only.

Returns the local socket address of this listener.

Examples

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

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

let addr = listener.local_addr().expect("Couldn't get local address");

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

This is supported on Unix only.

Moves the socket into or out of nonblocking mode.

Examples

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

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

listener.set_nonblocking(true).expect("Couldn't set non blocking");

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

This is supported on Unix only.

Returns the value of the SO_ERROR option.

Examples

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

let listener = UnixListener::bind("/tmp/sock").unwrap();

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

Platform specific

On Redox this always returns None.

Important traits for Incoming<'a>

impl<'a> Iterator for Incoming<'a> type Item = Result<UnixStream>;

pub fn incoming(&self) -> Incoming

This is supported on Unix only.

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) {
    // ...
}

let listener = UnixListener::bind("/path/to/the/socket").unwrap();

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

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 Debug for UnixListener

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a UnixListener

type Item = Result<UnixStream>

The type of the elements being iterated over.

type IntoIter = Incoming<'a>

Which kind of iterator are we turning this into?

Important traits for Incoming<'a>

impl<'a> Iterator for Incoming<'a> type Item = Result<UnixStream>;

fn into_iter(self) -> Incoming<'a>

Creates an iterator from a value.