Struct riker::actor::ActorRef

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

A lightweight, typed reference to interact with its underlying actor instance through concurrent messaging.

All ActorRefs are products of system.actor_of or context.actor_of. When an actor is created using actor_of an ActorRef<Msg> is returned, where Msg is the mailbox message type for the actor.

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

Messages sent to an actor are added to the actor's mailbox.

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.

fn uri(&self) -> &ActorUri

Actor URI.

fn path(&self) -> &ActorPath

Actor path.

fn is_root(&self) -> bool

True if this actor is the top level root

fn parent(&self) -> BasicActorRef

Parent reference

fn user_root(&self) -> BasicActorRef

User root reference

fn has_children(&self) -> bool

True is this actor has any children actors

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

True if the given actor is a child of this actor

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

Iterator over children references.

fn sys_tell(&self, msg: SystemMsg)

Send a system message to this actor

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

fn name(&self) -> &str

Actor name.

fn uri(&self) -> &ActorUri

Actor URI.

fn path(&self) -> &ActorPath

Actor path.

fn is_root(&self) -> bool

True if this actor is the top level root

fn parent(&self) -> BasicActorRef

Parent reference

fn user_root(&self) -> BasicActorRef

User root reference

fn has_children(&self) -> bool

True is this actor has any children actors

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

True if the given actor is a child of this actor

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

Iterator over children references.

fn sys_tell(&self, msg: SystemMsg)

Send a system message to this actor

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> 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> 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: 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> Display for ActorRef<Msg>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.