Struct ListenerOptions 

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

Available on crate features pubsub and ipc only.

A builder for local socket listeners, including Listener.

Implementations

impl ListenerOptions<'_>

Creation.

pub fn new() -> ListenerOptions<'_>

Creates an options table with default values.

impl<'n> ListenerOptions<'n>

Option setters.

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

Sets the name the server will listen on.

pub fn nonblocking( self, nonblocking: ListenerNonblockingMode, ) -> ListenerOptions<'n>

Selects the nonblocking mode to be used by the listener.

The default value is Neither.

pub fn reclaim_name(self, reclaim_name: bool) -> ListenerOptions<'n>

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, Error>

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>(self) -> Result<L, Error>

where L: Listener,

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

pub fn create_tokio(self) -> Result<Listener, Error>

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>(self) -> Result<L, Error>

where L: Listener,

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

Trait Implementations

impl Connect for ListenerOptions<'_>

type Listener = Listener

The listener type produced by the connect object.

type Error = Error

The error type for instantiating a Listener.

async fn make_listener(self) -> Result<Self::Listener, Self::Error>

Create the listener

fn notification_buffer_size(&self) -> usize

Configure the notification buffer size for each task spawned by the listener.

fn serve_with_handle( self, router: Router<()>, handle: Handle, ) -> impl Future<Output = Result<ServerShutdown, Self::Error>> + Send

Instantiate and run a task to accept connections, returning a shutdown signal.

fn serve( self, router: Router<()>, ) -> impl Future<Output = Result<ServerShutdown, Self::Error>> + Send

Instantiate and run a task to accept connections, returning a shutdown signal.

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

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

Formats the value using the given formatter.

impl Default for ListenerOptions<'_>

fn default() -> ListenerOptions<'_>

Returns the “default value” for a type.

impl ListenerOptionsExt for ListenerOptions<'_>

fn mode(self, mode: u32) -> ListenerOptions<'_>

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

impl TryClone for ListenerOptions<'_>

fn try_clone(&self) -> Result<ListenerOptions<'_>, Error>

Clones self, possibly returning an error.