Struct 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

Implementations

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<Self>>, ) -> 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<Self>>, ) -> Result<(), ()>

Trait Implementations

impl ActorReference for &BasicActorRef

fn name(&self) -> &str

Actor name.

Unique among siblings.

fn path(&self) -> &ActorPath

Actor path.

e.g. /user/actor_a/actor_b

fn parent(&self) -> BasicActorRef

Parent reference.

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

Iterator over children references.

fn uri(&self) -> &ActorUri

Actor URI.

fn is_root(&self) -> bool

True if this actor is the top level root

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 sys_tell(&self, msg: SystemMsg)

Send a system message to this actor

impl ActorReference for BasicActorRef

fn name(&self) -> &str

Actor name.

Unique among siblings.

fn path(&self) -> &ActorPath

Actor path.

e.g. /user/actor_a/actor_b

fn parent(&self) -> BasicActorRef

Parent reference.

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

Iterator over children references.

fn uri(&self) -> &ActorUri

Actor URI.

fn is_root(&self) -> bool

True if this actor is the top level root

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 sys_tell(&self, msg: SystemMsg)

Send a system message to this actor

impl Clone for BasicActorRef

fn clone(&self) -> BasicActorRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasicActorRef

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

Formats the value using the given formatter.

impl Display for BasicActorRef

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

Formats the value using the given formatter.

impl<Msg> From<ActorRef<Msg>> for BasicActorRef

where Msg: Message,

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

Converts to this type from the input type.

impl PartialEq for BasicActorRef

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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