Struct riker::actor::BasicActorRef

pub struct BasicActorRef {
    pub cell: ActorCell,
}

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

BasicActorRef can be derived from an original ActorRef<Msg>.

BasicActorRef allows for un-typed messaging using try_tell, that will return a Result. If the message type was not supported, the result will contain an Error.

BasicActorRef can be used when the original ActorRef isn't available, when you need to use collections to store references from different actor types, or when using actor selections to message parts of the actor hierarchy.

In general, it is better to use ActorRef where possible.

Fields

cell: ActorCell

Methods

impl BasicActorRef

pub fn typed<Msg: Message>(&self, cell: ExtendedCell<Msg>) -> ActorRef<Msg>

pub fn try_tell<Msg>(
    &self,
    msg: Msg,
    sender: impl Into<Option<BasicActorRef>>
) -> Result<(), ()> where
    Msg: Message + Send, 

Send a message to this actor

Returns a result. If the message type is not supported Error is returned.

pub fn try_tell_any(
    &self,
    msg: &mut AnyMessage,
    sender: impl Into<Option<BasicActorRef>>
) -> Result<(), ()>

Trait Implementations

impl ActorReference for BasicActorRef

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<'_> ActorReference for &'_ BasicActorRef

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 Clone for BasicActorRef

fn clone(&self) -> BasicActorRef

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Performs the conversion.

impl PartialEq<BasicActorRef> for BasicActorRef

fn eq(&self, other: &BasicActorRef) -> 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 Display for BasicActorRef

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

Formats the value using the given formatter.

impl Debug for BasicActorRef

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

Formats the value using the given formatter.