Struct ListenerOptions

pub struct ListenerOptions<'n> { /* private fields */ }

A builder for local socket listeners, including Listener.

Implementations

impl ListenerOptions<'_>

Creation.

pub fn new() -> Self

Creates an options table with default values.

impl<'n> ListenerOptions<'n>

Option setters.

pub fn name(self, name: Name<'n>) -> Self

Sets the name the server will listen on.

pub fn nonblocking(self, nonblocking: ListenerNonblockingMode) -> Self

Selects the nonblocking mode to be used by the listener.

The default value is Neither.

pub fn reclaim_name(self, reclaim_name: bool) -> Self

Sets whether name reclamation is to happen or not.

This is enabled by default.

impl ListenerOptions<'_>

Listener constructors.

pub fn create_sync(self) -> Result<Listener>

Creates a Listener, binding it to the specified local socket name.

On platforms where there are multiple available implementations, this dispatches to the appropriate implementation based on where the name points to.

pub fn create_sync_as<L: Listener>(self) -> Result<L>

Creates the given type of listener, binding it to the specified local socket name.

pub fn create_tokio(self) -> Result<TokioListener>

Creates a Listener, binding it to the specified local socket name.

On platforms where there are multiple available implementations, this dispatches to the appropriate implementation based on where the name points to.

pub fn create_tokio_as<L: Listener>(self) -> Result<L>

Creates the given type of listener, binding it to the specified local socket name.

Trait Implementations

impl<'n> Debug for ListenerOptions<'n>

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

Formats the value using the given formatter.

impl Default for ListenerOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl ListenerOptionsExt for ListenerOptions<'_>

Available on Unix only.

fn mode(self, mode: mode_t) -> Self

Sets the file mode (Unix permissions) to be applied to the socket file.

impl TryClone for ListenerOptions<'_>

fn try_clone(&self) -> Result<Self>

Clones self, possibly returning an error.