Struct AgentRuntime

pub struct AgentRuntime(/* private fields */);

Represents a ready state of the Acton system.

This struct encapsulates the internal state of the Acton system when it’s ready for use. It provides methods for creating and managing actors within the system.

Implementations

impl AgentRuntime

pub async fn new_agent_with_name<State>( &mut self, name: String, ) -> ManagedAgent<Idle, State>

where State: Default + Send + Debug + 'static,

Creates a new actor with the provided id root name.

Type Parameters

• State - The state type of the actor, which must implement Default, Send, Debug, and have a static lifetime.

Returns

A ManagedActor in the Idle state with the specified State.

pub async fn new_agent<State>(&mut self) -> ManagedAgent<Idle, State>

where State: Default + Send + Debug + 'static,

Creates a new actor with default configuration.

Type Parameters

• State - The state type of the actor, which must implement Default, Send, Debug, and have a static lifetime.

Returns

A ManagedActor in the Idle state with the specified State.

pub fn agent_count(&self) -> usize

Retrieves the number of actors currently running in the system.

pub async fn create_actor_with_config<State>( &mut self, config: AgentConfig, ) -> ManagedAgent<Idle, State>

where State: Default + Send + Debug + 'static,

Creates a new actor with a specified configuration.

Type Parameters

• State - The state type of the actor, which must implement Default, Send, Debug, and have a static lifetime.

Arguments

• config - The ActorConfig to use for creating the actor.

Returns

A ManagedActor in the Idle state with the specified State and configuration.

pub fn broker(&self) -> AgentHandle

Retrieves the broker reference for the system.

Returns

A clone of the BrokerRef associated with this SystemReady instance.

pub async fn spawn_agent_with_setup_fn<State>( &mut self, config: AgentConfig, setup_fn: impl FnOnce(ManagedAgent<Idle, State>) -> Pin<Box<dyn Future<Output = AgentHandle> + Send + 'static>>, ) -> Result<AgentHandle>

where State: Default + Send + Debug + 'static,

Spawns an actor with a custom setup function and configuration.

Type Parameters

• State - The state type of the actor, which must implement Default, Send, Debug, and have a static lifetime.

Arguments

• config - The ActorConfig to use for creating the actor.
• setup_fn - A function that takes a ManagedActor and returns a Future resolving to an ActorRef.

Returns

A Result containing the ActorRef of the spawned actor, or an error if the spawn failed.

pub async fn shutdown_all(&mut self) -> Result<()>

Shuts down the Acton system, stopping all actors and their children.

pub async fn spawn_actor<State>( &mut self, setup_fn: impl FnOnce(ManagedAgent<Idle, State>) -> Pin<Box<dyn Future<Output = AgentHandle> + Send + 'static>>, ) -> Result<AgentHandle>

where State: Default + Send + Debug + 'static,

Spawns an actor with a custom setup function and default configuration.

Type Parameters

• State - The state type of the actor, which must implement Default, Send, Debug, and have a static lifetime.

Arguments

• setup_fn - A function that takes a ManagedActor and returns a Future resolving to an ActorRef.

Returns

A Result containing the ActorRef of the spawned actor, or an error if the spawn failed.

Trait Implementations

impl Clone for AgentRuntime

fn clone(&self) -> AgentRuntime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AgentRuntime

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

Formats the value using the given formatter.

impl Default for AgentRuntime

fn default() -> AgentRuntime

Returns the “default value” for a type.

impl From<ActonApp> for AgentRuntime

fn from(_acton: ActonApp) -> Self

Converts to this type from the input type.