Jido.Agent.Identity.Agent (Jido v2.3.0)

Helper for managing identity state in an agent.

Identity state is stored at the reserved key :__identity__ in agent.state.

Summary

Functions

ensure(agent, opts \\ [])

Ensure agent has an identity, initializing it when missing.

get(agent, default \\ nil)

Get identity state from agent state.

has_identity?(agent)

Check if agent has identity state.

key()

Returns the reserved key for identity storage.

put(agent, identity)

Put identity state into agent state.

snapshot(agent)

Return a public snapshot of the agent's identity.

update(agent, fun)

Update identity state using a function.

Functions

ensure(agent, opts \\ [])

@spec ensure(
  Jido.Agent.t(),
  keyword()
) :: Jido.Agent.t()

Ensure agent has an identity, initializing it when missing.

get(agent, default \\ nil)

@spec get(Jido.Agent.t(), Jido.Agent.Identity.t() | nil) ::
  Jido.Agent.Identity.t() | nil

Get identity state from agent state.

has_identity?(agent)

@spec has_identity?(Jido.Agent.t()) :: boolean()

Check if agent has identity state.

key()

@spec key() :: atom()

Returns the reserved key for identity storage.

put(agent, identity)

@spec put(Jido.Agent.t(), Jido.Agent.Identity.t()) :: Jido.Agent.t()

Put identity state into agent state.

snapshot(agent)

@spec snapshot(Jido.Agent.t()) :: map() | nil

Return a public snapshot of the agent's identity.

update(agent, fun)

@spec update(Jido.Agent.t(), (Jido.Agent.Identity.t() | nil ->
                          Jido.Agent.Identity.t())) ::
  Jido.Agent.t()

Update identity state using a function.