Struct Fluxion 

pub struct Fluxion<D> { /* private fields */ }

Fluxion

Contains the core actor management functionality of fluxion

Implementations

impl<D: Delegate> Fluxion<D>

pub fn new(id: &str, delegate: D) -> Self

Fluxion::new

Creates a new Fluxion instance with the given system id and delegate

pub fn get_delegate(&self) -> &D

Fluxion::get_delegate

Gets a reference to the delegate.

pub fn get_id(&self) -> &str

Fluxion::get_id

Gets the system’s id

pub async fn get_actor_id(&self, name: &str) -> Option<u64>

Fluxion::get_actor_id

Retrieve’s an actor’s ID by its name

pub async fn add_named<A: Actor>( &self, name: &str, actor: A, ) -> Result<u64, A::Error>

Fluxion::add_named

Adds an actor to the local instance, returning its id and assigning the given name to it for retrieval by Fluxion::get_actor_id. This is handy when using actors with static names on a foreign system.

Locks the underlying RwLock as write. This will block "management" functionalities such as adding, removing, and retrieving actors, but will not block any messages.

If an actor with a duplicate name is added, it will overwrite the original actor's name. The original actor won't be killed, but it may become inaccessible.

Errors

Returns an error if the actor failed to initialize. On an error, the actor will not be spawned, and the name will not be assigned.

pub async fn add<A: Actor>(&self, actor: A) -> Result<u64, A::Error>

Fluxion::add

Adds an actor to the local instance, returning its id.

Locks the underlying RwLock as write. This will block "management" functionalities such as adding, removing, and retrieving actors, but will not block any messages.

Errors

Returns an error if the actor failed to initialize. On an error, the actor will not be spawned.

pub async fn kill<A: Actor>(&self, id: u64)

Fluxion::kill

Given an actor’s id, kills the actor

Locks the underlying RwLock as write. This will block "management" functionalities such as adding, removing, and retrieving actors, but will not block any messages.

pub async fn get_local<A: Actor>(&self, id: u64) -> Option<LocalRef<A, D>>

Fluxion::get_local

Gets an actor that is known to reside on the local system. This allows messages that are not serializable to still be used even if Fluxion is compiled with foreign message support. This function also allows retrieving an actor handle that is capable of sending multiple different messages.

pub async fn get<'a, A: Handler<M>, M: IndeterminateMessage>( &self, id: impl Into<Identifier<'a>>, ) -> Option<Arc<dyn MessageSender<M>>>

Fluxion::get

Retrieves an actor reference capable of communicating using the given message via the given ID.

pub async fn shutdown(&self)

Fluxion::shutdown

Removes all actors from the system and deallocates the underlying slab.

Locks the underlying RwLock as write. This will block "management" functionalities such as adding, removing, and retrieving actors, but will not block any messages.

Trait Implementations

impl<D> Clone for Fluxion<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.