Struct AgentUiState 

pub struct AgentUiState {
    pub steps: Vec<AgentStep>,
    pub current_tool: Option<String>,
    pub tool_results: Vec<ToolResult>,
    pub metadata: Option<Value>,
}

Agent state for generative UI rendering.

This state is streamed to frontends via STATE_SNAPSHOT events and can be rendered using CopilotKit’s useCoAgentStateRender.

Fields

steps: Vec<AgentStep>

Steps showing progress of agent execution.

current_tool: Option<String>

Current tool being executed (if any).

tool_results: Vec<ToolResult>

Tool results for rich UI rendering.

metadata: Option<Value>

Additional metadata for custom rendering.

Implementations

impl AgentUiState

pub fn new() -> Self

Creates a new empty agent state.

pub fn add_step(&mut self, description: impl Into<String>)

Adds a pending step.

pub fn complete_step(&mut self, index: usize)

Marks a step as completed by index.

pub fn complete_current_step(&mut self)

Marks the first pending step as completed.

pub fn set_current_tool(&mut self, tool: Option<String>)

Sets the current tool being executed.

pub fn add_tool_result( &mut self, tool_name: String, args: Value, result: Value, is_error: bool, )

Adds a tool result for rich UI rendering.

pub fn to_json(&self) -> Value

Converts to JSON value for state events.

Trait Implementations

impl Clone for AgentUiState

fn clone(&self) -> AgentUiState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentUiState

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

Formats the value using the given formatter.

impl Default for AgentUiState

fn default() -> AgentUiState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentUiState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AgentUiState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.