Struct UnixListener 

pub struct UnixListener { /* private fields */ }

Available on Unix and crate feature local only.

A Unix domain socket listener. Dropping it removes its socket file, but only while the path still names the file this listener created.

let listener = net_io::UnixListener::bind("/run/myapp/control.sock")?;
let (mut conn, info) = listener.accept()?;
println!("uid {:?}", info.peer_credentials.and_then(|c| c.uid));
conn.send_all(b"ready\n")?;

Implementations

impl UnixListener

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

Binds path with LocalOptions::new: mode 0600, a stale socket file removed.

Errors

PathTooLong, StaleSocketInUse, PermissionDenied, NotFound (no such directory), InvalidConfig { field: "path" }, Os.

pub fn bind_with<P: AsRef<Path>>( path: P, options: LocalOptions, ) -> Result<UnixListener, NetError>

Binds path with options: the socket is bound, given its mode and owner, and only then listens, so no connection is accepted under the umask’s permissions.

Errors

As UnixListener::bind.

pub fn bind_atomic<P: AsRef<Path>>( path: P, options: LocalOptions, ) -> Result<UnixListener, NetError>

As UnixListener::bind_with, but bound under a temporary name in the same directory and renamed into place once it listens with its final mode: the path never names a socket that refuses or is not ready.

Errors

As UnixListener::bind.

pub fn accept(&self) -> Result<(UnixConnection, ConnectionInfo), NetError>

Blocks until a connection arrives. Peer credentials are read once and stored in ConnectionInfo; with require_uid, other users’ connections are closed before any read and accepting continues.

Errors

Limit { which: Descriptors } when exhaustion persists past one backoff step; Os.

pub fn accept_timeout( &self, timeout: Duration, ) -> Result<Option<(UnixConnection, ConnectionInfo)>, NetError>

As UnixListener::accept, but Ok(None) when nothing arrived within timeout.

Errors

As UnixListener::accept.

pub fn info(&self) -> &ListenerInfo

Facts about this listener.

pub fn path(&self) -> Option<&Path>

The path this listener was bound to (recorded at bind, not read back: decision D-058); for an adopted socket, the path the OS reports.

Trait Implementations

impl AsFd for UnixListener

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

Borrows the file descriptor.

impl Debug for UnixListener

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

Formats the value using the given formatter.

impl Drop for UnixListener

fn drop(&mut self)

Removes the socket file only if the path still names the file this listener created, never a replacement someone else bound.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.