Skip to main content

AgentState

Struct AgentState 

Source
pub struct AgentState {
    pub messages: Vec<Message>,
    pub iteration: usize,
    pub stop_reason: Option<StopReason>,
    pub tool_results: Vec<ToolResult>,
    pub total_tokens: usize,
    pub input_tokens: usize,
    pub output_tokens: usize,
}
Expand description

Agent execution state

Tracks the full lifecycle of an agent conversation including messages, token usage, tool results, and iteration progress.

Derives Serialize/Deserialize for session persistence and cross-process state transfer (e.g. oxios supervisor serialization).

Fields§

§messages: Vec<Message>

Conversation message history (user, assistant, and tool-result messages).

§iteration: usize

Current agent loop iteration (incremented after each assistant turn).

§stop_reason: Option<StopReason>

The reason the last turn stopped, if any.

§tool_results: Vec<ToolResult>

Accumulated results from tool executions in the current conversation.

§total_tokens: usize

Cumulative token count (input + output) across all turns.

§input_tokens: usize

Cumulative prompt / input tokens across all turns.

§output_tokens: usize

Cumulative completion / output tokens across all turns.

Implementations§

Source§

impl AgentState

Source

pub fn new() -> Self

Create a new, default-initialized agent state.

Source

pub fn add_user_message(&mut self, content: String)

Add a user message

Source

pub fn add_assistant_message(&mut self, content: String)

Add an assistant message

Source

pub fn add_tool_result(&mut self, tool_call_id: String, content: String)

Add a tool result message to both the message history and the tool results list.

Source

pub fn increment_iteration(&mut self)

Increment the iteration counter after an assistant turn completes.

Source

pub fn set_stop_reason(&mut self, reason: StopReason)

Record the reason the last turn stopped.

Source

pub fn record_usage(&mut self, input: usize, output: usize)

Accumulate token usage from a completed LLM call.

Source

pub fn clear(&mut self)

Clear all state, resetting for a new conversation.

Source

pub fn replace_messages(&mut self, messages: Vec<Message>)

Replace the entire message history (used after context compaction).

Source

pub fn estimate_tokens(&self) -> usize

Rough token-count estimate based on the serialized message JSON length.

Source

pub fn is_complete(&self) -> bool

Returns true if the agent has signaled a stop reason.

Trait Implementations§

Source§

impl Clone for AgentState

Source§

fn clone(&self) -> AgentState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AgentState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AgentState

Source§

fn default() -> AgentState

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AgentState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AgentState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,