Struct actix_rt::Arbiter

pub struct Arbiter { /* fields omitted */ }

Arbiters provide an asynchronous execution environment for actors, functions and futures. When an Arbiter is created, it spawns a new OS thread, and hosts an event loop. Some Arbiter functions execute on the current thread.

Implementations

impl Arbiter

pub fn current() -> Arbiter

Returns the current thread’s arbiter’s address. If no Arbiter is present, then this function will panic!

pub fn is_running() -> bool

Check if current arbiter is running.

pub fn stop(&self)

Stop arbiter from continuing it’s event loop.

pub fn new() -> Arbiter

Spawn new thread and run event loop in spawned thread. Returns address of newly created arbiter.

pub fn spawn<F>(future: F) where
    F: Future<Output = ()> + 'static, 

Spawn a future on the current thread. This does not create a new Arbiter or Arbiter address, it is simply a helper for spawning futures on the current thread.

pub fn spawn_fn<F, R>(f: F) where
    F: FnOnce() -> R + 'static,
    R: Future<Output = ()> + 'static, 

Executes a future on the current thread. This does not create a new Arbiter or Arbiter address, it is simply a helper for executing futures on the current thread.

pub fn send<F>(&self, future: F) where
    F: Future<Output = ()> + Send + Unpin + 'static, 

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

pub fn exec_fn<F>(&self, f: F) where
    F: FnOnce() + Send + 'static, 

Send a function to the Arbiter’s thread, and execute it. Any result from the function is discarded.

pub fn exec<F, R>(&self, f: F) -> impl Future<Output = Result<R, Canceled>> where
    F: FnOnce() -> R + Send + 'static,
    R: Send + 'static, 

Send a function to the Arbiter’s thread. This function will be executed asynchronously. A future is created, and when resolved will contain the result of the function sent to the Arbiters thread.

pub fn set_item<T: 'static>(item: T)

Set item to arbiter storage

pub fn contains_item<T: 'static>() -> bool

Check if arbiter storage contains item

pub fn get_item<T: 'static, F, R>(f: F) -> R where
    F: FnMut(&T) -> R, 

Get a reference to a type previously inserted on this arbiter’s storage.

Panics is item is not inserted

pub fn get_mut_item<T: 'static, F, R>(f: F) -> R where
    F: FnMut(&mut T) -> R, 

Get a mutable reference to a type previously inserted on this arbiter’s storage.

Panics is item is not inserted

pub fn join(&mut self) -> Result<()>

Wait for the event loop to stop by joining the underlying thread (if have Some).

pub fn local_join() -> impl Future<Output = ()>

Returns a future that will be completed once all currently spawned futures have completed.

Trait Implementations

impl Clone for Arbiter

fn clone(&self) -> Self

Returns a copy 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

Formats the value using the given formatter.

impl Default for Arbiter

fn default() -> Self

Returns the “default value” for a type.