Struct Arbiter 

pub struct Arbiter(/* private fields */);

An asynchronous execution environment running on one OS thread.

Creating an arbiter starts a thread with its own local event loop. Futures spawned on that event loop are not required to implement Send.

Implementations

impl Arbiter

pub fn current() -> Arbiter

Returns the arbiter running on the current thread.

Panics

Panics if no arbiter is running on the current thread.

pub fn stop(&self)

Requests that the arbiter stop its event loop.

pub fn new() -> Arbiter

Starts an arbiter on a new thread with an automatically generated name.

pub fn with_name(name: String) -> Arbiter

Starts an arbiter on a new thread with the specified name.

pub fn id(&self) -> Id

Returns the arbiter identifier.

pub fn name(&self) -> &str

Returns the arbiter name.

pub fn handle(&self) -> &Handle

Returns a handle to the arbiter’s runtime.

pub fn is_running(&self) -> bool

Returns whether the arbiter is running.

pub fn get_value<T, F>(f: F) -> T

where T: Clone + 'static, F: FnOnce() -> T,

Returns a value from thread-local arbiter storage, inserting it if absent.

If the storage has already been destroyed because the thread is exiting, the value returned by f is not stored.

pub fn on_shutdown<F>(f: F)

where F: FnOnce() + 'static,

Registers a callback to run when the current thread’s arbiter shuts down.

Callbacks run once, in registration order, on the arbiter’s thread when its stop is requested, by Arbiter::stop() or System::stop(), while the event loop is still running. An arbiter that ends without a stop request, such as one driven by SystemRunner::block_on(), runs them once its event loop has exited instead. A callback registered by another callback runs in the same shutdown.

If the thread is exiting and its thread-local storage has already been destroyed, f is dropped without running.

pub fn on_stop<F>(self, f: F) -> Arbiter

where F: Fn() + Send + Sync + 'static,

Adds a callback to run after the arbiter stops.

pub fn join(&mut self) -> Result<(), Box<dyn Any + Send>>

Waits for the arbiter’s thread to stop.

This returns immediately for an arbiter that does not own a thread handle, including the system’s primary arbiter.

Trait Implementations

impl Clone for Arbiter

fn clone(&self) -> Arbiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Arbiter

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

Formats the value using the given formatter.

impl Default for Arbiter

fn default() -> Arbiter

Returns the “default value” for a type.

impl Eq for Arbiter

impl PartialEq for Arbiter

fn eq(&self, other: &Arbiter) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.