Struct riker::actor::ActorRef

pub struct ActorRef<Msg: Message> {
    pub cell: ExtendedCell<Msg>,
}

An actor reference exposes methods to interact with its underlying actor.

All actor references are products of system.actor_of or context.actor_of. When an actor is created using actor_of an ActorRef is returned.

Actor references are lightweight and can be cloned without concern for memory use.

In the event that the underlying actor is terminated messages sent to the actor will be routed to dead letters.

If an actor is restarted all existing references continue to be valid.

Fields

cell: ExtendedCell<Msg>

Methods

impl<Msg: Message> ActorRef<Msg>

pub fn send_msg(&self, msg: Msg, sender: impl Into<Option<BasicActorRef>>)

Trait Implementations

impl<Msg: Message> ActorReference for ActorRef<Msg>

fn name(&self) -> &str

Actor name.

Unique among siblings.

fn uri(&self) -> &ActorUri

fn path(&self) -> &ActorPath

Actor path.

e.g. /user/actor_a/actor_b

fn is_root(&self) -> bool

fn parent(&self) -> BasicActorRef

Parent reference.

fn user_root(&self) -> BasicActorRef

fn has_children(&self) -> bool

fn is_child(&self, actor: &BasicActorRef) -> bool

fn children<'a>(&'a self) -> Box<dyn Iterator<Item = BasicActorRef> + 'a>

Iterator over children references.

fn sys_tell(&self, msg: SystemMsg)

impl<'_, Msg: Message> ActorReference for &'_ ActorRef<Msg>

fn name(&self) -> &str

Actor name.

Unique among siblings.

fn uri(&self) -> &ActorUri

fn path(&self) -> &ActorPath

Actor path.

e.g. /user/actor_a/actor_b

fn is_root(&self) -> bool

fn parent(&self) -> BasicActorRef

Parent reference.

fn user_root(&self) -> BasicActorRef

fn has_children(&self) -> bool

fn is_child(&self, actor: &BasicActorRef) -> bool

fn children<'a>(&'a self) -> Box<dyn Iterator<Item = BasicActorRef> + 'a>

Iterator over children references.

fn sys_tell(&self, msg: SystemMsg)

impl<T, M> Tell<T> for ActorRef<M> where
    T: Message + Into<M>,
    M: Message, 

fn tell(&self, msg: T, sender: Sender)

fn box_clone(&self) -> BoxedTell<T>

impl<Msg: Clone + Message> Clone for ActorRef<Msg>

fn clone(&self) -> ActorRef<Msg>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Msg: Message> PartialEq<ActorRef<Msg>> for ActorRef<Msg>

fn eq(&self, other: &ActorRef<Msg>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Msg> From<ActorRef<Msg>> for BasicActorRef where
    Msg: Message, 

fn from(actor: ActorRef<Msg>) -> BasicActorRef

Performs the conversion.

impl<Msg> From<ActorRef<Msg>> for Option<BasicActorRef> where
    Msg: Message, 

fn from(actor: ActorRef<Msg>) -> Option<BasicActorRef>

Performs the conversion.

impl<Msg: Message> Debug for ActorRef<Msg>

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

Formats the value using the given formatter.

impl<Msg: Message> Display for ActorRef<Msg>

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

Formats the value using the given formatter.