Struct crossbus::register::ActorRegister

pub struct ActorRegister { /* private fields */ }

A record will registered into REGISTER for future use (Create/Read/Update/Delete)

each record contains

• id: usize, the unique identifier of the actor.
• actor: the type implemented Acotr trait
• sealed: AtomicBool, status marker indicates the actor is mutably borrowed or not
• type_id: the type id of Acotr trait implementor
• message_id: the type id of the type implemented Message trait
• name: String, the name of the registered actor, the default format is Acotr-{id}, customize it with set_name.
• closed: AtomicBool, status marker indicates the actor is closed or not

Implementations

impl ActorRegister

pub fn new<A>(act: A) -> Selfwhere A: Actor,

create a Actor Register for an actor instance

pub fn id(&self) -> usize

the unqiue identity of the Actor

pub fn type_id(&self) -> TypeId

the TypeId of the Actor

pub fn message_id(&self) -> TypeId

the TypeId of the Actor::Message

pub fn name(&self) -> &str

the name of the Actor you can set it with set_name

pub fn set_name<T: Into<String>>(&mut self, name: T)

set the name of the Actor

pub fn is_closed(&self) -> bool

the state of the Actor you can set it with set_closed

pub fn set_closed(&self, state: bool)

set the actor is closed

pub fn is_sealed(&self) -> bool

indicator that whether the Actor is being downcasted to Actor and mutating

pub fn downcast_ref<A: Actor>(&self) -> Option<&A>

downcast the type Actor type &A

pub fn downcast_mut<A: Actor, F>(&self, f: F) -> Option<bool>where F: FnMut(&mut A) -> Result<(), ()>,

downcast the type Actor type &mut A then mutate it with the function f

and return

• None: downcast failed
• Some(false): downcasted and f return Err(_)
• Some(true): downcasted and f return Ok(_)

the underlying actor will be guarded when downcasted no more mutable access is allowed during downcasted

Trait Implementations

impl Debug for ActorRegister

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

Formats the value using the given formatter.

impl Send for ActorRegister

Safety: since it is guardted with AtomicBool for generic A: Actor

• nothing changes to the Inner data when downcasted to &A,
• seal the inner to deny more than one access when downcasted to &mut A

So it is safe to send &A between threads

impl Sync for ActorRegister

Safety: since it is guardted with AtomicBool for generic A: Actor

• nothing changes to the Inner data when downcasted to &A,
• seal the inner to deny more than one access when downcasted to &mut A

So it is safe to send &A between threads