Struct AgentHandle

pub struct AgentHandle {
    pub parent: Option<Box<AgentHandle>>,
    pub broker: Box<Option<AgentHandle>>,
    /* private fields */
}

Represents the context in which an actor operates.

Fields

parent: Option<Box<AgentHandle>>

The actor’s optional parent context.

broker: Box<Option<AgentHandle>>

The system broker for the actor.

Implementations

impl AgentHandle

pub async fn supervise<State: Default + Send + Debug>( &self, child: ManagedAgent<Idle, State>, ) -> Result<AgentHandle>

Supervises a child actor by activating it and tracking its context.

This asynchronous method adds a child actor to the supervision hierarchy managed by this ActorRef. It performs the following steps:

1. Logs the addition of the child actor with its unique identifier (ern).
2. Activates the child actor by calling its activate method asynchronously.
3. Retrieves the ern (unique identifier) from the child’s context.
4. Inserts the child’s context into the children map of the supervising actor, using the ern as the key.

Type Parameters

• State: Represents the state type associated with the child actor. It must implement the Default, Send, and Debug traits.

Parameters

• child: A ManagedAgent instance representing the child actor to be supervised.

Returns

A Result which is:

• Ok(()) if the child actor was successfully supervised and added to the supervision hierarchy.
• An error of type anyhow::Error if any step of the supervision process fails.

Errors

This method will return an error if:

• The child actor fails to activate.
• Inserting the child context into the children map fails.

Trait Implementations

impl Actor for AgentHandle

fn reply_address(&self) -> MessageAddress

Returns the message address for this agent.

fn create_envelope( &self, recipient_address: Option<MessageAddress>, ) -> OutboundEnvelope

Returns an envelope for the specified recipient and message, ready to send.

fn tracker(&self) -> TaskTracker

Returns the task tracker for the actor.

fn stop(&self) -> impl Future<Output = Result<()>> + Send + Sync + '_

Suspends the actor.

fn children(&self) -> DashMap<String, AgentHandle>

Returns a map of the actor’s children.

fn find_child(&self, arn: &Ern) -> Option<AgentHandle>

Finds a child actor by its ERN.

fn id(&self) -> Ern

Returns the actor’s ERN.

fn name(&self) -> String

Returns the actor’s root from the ERN.

fn clone_ref(&self) -> AgentHandle

Creates a clone of the actor’s reference.

fn send( &self, message: impl ActonMessage, ) -> impl Future<Output = ()> + Send + Sync + '_

where Self: Sync,

Emits a message from the actor, possibly to a pool item.

fn send_sync( &self, message: impl ActonMessage, recipient: &AgentHandle, ) -> Result<()>

where Self: Actor,

Send a message synchronously.

impl Broker for AgentHandle

fn broadcast( &self, message: impl ActonMessage, ) -> impl Future<Output = ()> + Send + Sync + '_

Broadcast a message from the broker.

fn broadcast_sync(&self, message: impl ActonMessage) -> Result<()>

where Self: Actor,

Broadcast a message from the broker synchronously.

impl Clone for AgentHandle

fn clone(&self) -> AgentHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AgentHandle

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

Formats the value using the given formatter.

impl Default for AgentHandle

fn default() -> Self

Returns the “default value” for a type.

impl Hash for AgentHandle

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AgentHandle

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.

impl Subscriber for AgentHandle

fn get_broker(&self) -> Option<AgentHandle>

Retrieves the broker associated with this subscriber.

impl Eq for AgentHandle