Struct IpcListener 

pub struct IpcListener { /* private fields */ }

A bound Unix domain socket listener that unlinks its socket file on drop.

A UnixListener does not remove its filesystem node when closed, so every IPC endpoint would otherwise leave a stale socket behind (libzmq unlinks the endpoint on close). This wrapper records the bound path and removes it on Drop, guarding the unlink so it only ever removes a socket node.

It Derefs to the underlying UnixListener, so it can be used anywhere a &UnixListener is expected (e.g. accept).

Implementations

impl IpcListener

pub const fn listener(&self) -> &UnixListener

Borrow the underlying listener.

pub fn path(&self) -> &Path

The filesystem path this listener is bound to.

Methods from Deref<Target = UnixListener>

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

Accepts a new incoming connection from this listener.

This function will yield once a new Unix domain socket connection is established. When established, the corresponding UnixStream and the remote peer’s address will be returned.

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

Returns a stream of incoming connections to this listener.

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

Returns the local address that this listener is bound to.

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

Returns the value of the SO_ERROR option.

Trait Implementations

impl Debug for IpcListener

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

Formats the value using the given formatter.

impl Deref for IpcListener

Available on Unix only.

type Target = UnixListener

The resulting type after dereferencing.

fn deref(&self) -> &<IpcListener as Deref>::Target

Dereferences the value.

impl Drop for IpcListener

Available on Unix only.

fn drop(&mut self)

Executes the destructor for this type.

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.