Struct Cluster 

pub struct Cluster { /* private fields */ }

Available on crate feature actor only.

A set of Compio workers on which actors are placed.

Implementations

impl Cluster

pub fn current() -> Cluster

Returns the cluster running the current actor.

Panics

Panics when called outside an actor managed by a cluster.

pub fn try_current() -> Option<Cluster>

Try to get the cluster running the current actor.

impl Cluster

pub fn new() -> Result<Cluster, Error>

Creates a cluster using the dispatcher’s defaults.

pub fn from_dispatcher(dispatcher: Dispatcher) -> Cluster

Creates a cluster from a configured dispatcher.

pub fn spawn<A, F>( &self, factory: F, arguments: <A as Actor>::Arguments, ) -> Spawn<'_, A, F>

where A: Actor, F: FnOnce() -> A + Send + 'static,

Configures an actor spawn operation.

The return type is a configurable future implementing IntoFuture. See Spawn for detail.

pub fn lookup<A, N>(&self, name: N) -> Option<Mailbox<A>>

where A: Actor, N: Into<Cow<'static, str>>,

Looks up a named actor of type A.

pub async fn join(self) -> Result<(), Error>

Stops the dispatcher workers and waits for their threads to exit.

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a duplicate of the value.

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

Performs copy-assignment from source.