Struct ArbiterHandle

pub struct ArbiterHandle { /* private fields */ }

A handle for sending spawn and stop messages to an Arbiter.

Implementations

impl ArbiterHandle

pub fn spawn<Fut>(&self, future: Fut) -> bool

where Fut: Future<Output = ()> + Send + 'static,

Send a future to the Arbiter’s thread and spawn it.

If you require a result, include a response channel in the future.

Returns true if future was sent successfully and false if the Arbiter has died.

pub fn spawn_fn<F>(&self, f: F) -> bool

where F: FnOnce() + Send + 'static,

Send a function to the Arbiter’s thread and execute it.

Any result from the function is discarded. If you require a result, include a response channel in the function.

Returns true if function was sent successfully and false if the Arbiter has died.

pub fn stop(&self) -> bool

Instruct Arbiter to stop processing it’s event loop.

Returns true if stop message was sent successfully and false if the Arbiter has been dropped.

Trait Implementations

impl Clone for ArbiterHandle

fn clone(&self) -> ArbiterHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArbiterHandle

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

Formats the value using the given formatter.