Jido.Agent.Strategy.State (Jido v2.0.0-rc.0)

Helper module for managing strategy-specific state within an Agent.

Strategy state is stored under the reserved key :__strategy__ in agent.state. This keeps all state within the Agent struct for serializability and snapshot/restore.

Structure

The strategy state typically contains:

:module - The strategy module managing this state
:status - Current execution status (:idle, :running, :waiting, :success, :failure)
:data - Strategy-specific data (e.g., BT cursor, LLM conversation history)

Example

# In a Behavior Tree strategy
agent = Strategy.State.put(agent, %{
  module: __MODULE__,
  status: :running,
  tree: bt_definition,
  cursor: root_node
})

# Later, read the state
state = Strategy.State.get(agent)
state.cursor  # => root_node

Summary

Types

status()

t()

Functions

active?(agent)

Check if the strategy is actively running (not idle or terminal).

clear(agent)

Clear strategy state, resetting to empty map.

get(agent, default \\ %{})

Get the strategy state from an agent. Returns the default if no strategy state exists.

key()

Returns the reserved key used for strategy state.

put(agent, new_state)

Put new strategy state into an agent. Replaces any existing strategy state.

set_status(agent, status)

Set the strategy status.

status(agent)

Get the current strategy status. Returns :idle if no status is set.

terminal?(agent)

Check if the strategy is in a terminal state (success or failure).

update(agent, fun)

Update strategy state using a function. The function receives the current strategy state (or empty map) and returns the new state.