Struct actix_rt::Arbiter

pub struct Arbiter { /* private fields */ }

An Arbiter represents a thread that provides an asynchronous execution environment for futures and functions.

When an arbiter is created, it spawns a new OS thread, and hosts an event loop.

Implementations

impl Arbiter

pub fn new() -> Arbiter

Spawn a new Arbiter thread and start its event loop.

Panics

Panics if a System is not registered on the current thread.

pub fn with_tokio_rt<F>(runtime_factory: F) -> Arbiterwhere
    F: Fn() -> Runtime + Send + 'static,

Spawn a new Arbiter using the Tokio Runtime returned from a closure.

pub fn handle(&self) -> ArbiterHandle

Return a handle to the this Arbiter’s message sender.

pub fn current() -> ArbiterHandle

Return a handle to the current thread’s Arbiter’s message sender.

Panics

Panics if no Arbiter is running on the current thread.

pub fn try_current() -> Option<ArbiterHandle>

Try to get current running arbiter handle.

Returns None if no Arbiter has been started.

Unlike current, this never panics.

pub fn stop(&self) -> bool

Stop Arbiter from continuing it’s event loop.

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

pub fn spawn<Fut>(&self, future: Fut) -> boolwhere
    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) -> boolwhere
    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 join(self) -> Result<()>

Wait for Arbiter’s event loop to complete.

Joins the underlying OS thread handle. See JoinHandle::join.

Trait Implementations

impl Debug for Arbiter

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

Formats the value using the given formatter.