Struct riker::actor::ActorRef

pub struct ActorRef<Msg: Message> {
    pub uri: ActorUri,
    pub cell: ActorCell<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 function.

Fields

uri: ActorUri

cell: ActorCell<Msg>

Implementations

impl<Msg: Message> ActorRef<Msg>

pub fn name(&self) -> &str

Actor name.

Unique among siblings.

pub fn path(&self) -> &String

Actor path.

e.g. /user/actor_a/actor_b

pub fn is_root(&self) -> bool

pub fn parent(&self) -> ActorRef<Msg>

Parent reference.

pub fn user_root(&self) -> ActorRef<Msg>

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

Iterator over children references.

Trait Implementations

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> 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.

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 ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

type Msg = Msg

fn sys_tell(&self, sys_msg: SystemMsg<Msg>, sender: Option<ActorRef<Msg>>)

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

type Msg = Msg

fn tell<T>(&self, msg: T, sender: Option<ActorRef<Self::Msg>>)where
    T: Into<ActorMsg<Self::Msg>>,

Implement to provide message routing to actors, e.g. ActorRef and ActorSelection