Enum AgentEvent 

#[non_exhaustive]
pub enum AgentEvent {
    TextDelta {
        content: String,
    },
    ToolCallStart {
        id: String,
        name: String,
    },
    ToolCallDelta {
        id: String,
        arguments_delta: String,
    },
    ToolCallEnd {
        id: String,
    },
    ToolResult {
        id: String,
        output: ToolOutput,
    },
    ToolProgress {
        id: String,
        message: String,
        progress_pct: Option<f32>,
    },
    StateUpdate {
        patch: Value,
    },
    DirectiveEmitted {
        directive: Value,
    },
    StatusUpdate {
        status: String,
        progress_pct: Option<f32>,
    },
    UsageUpdate {
        usage: Usage,
    },
    RateLimitInfo {
        utilization_pct: f32,
        reset_at: i64,
        allowed: bool,
    },
    TaskNotification {
        task_id: String,
        kind: TaskEventKind,
        payload: Value,
    },
    PromptSuggestion {
        suggestions: Vec<String>,
    },
    TurnComplete {
        reason: TerminationReason,
    },
    Error {
        message: String,
    },
}

Agent streaming event.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TextDelta

Text delta (streaming).

Fields

content: String

Content chunk.

ToolCallStart

Tool call started.

Fields

id: String

Tool call ID.

name: String

Tool name.

ToolCallDelta

Tool call arguments delta (streaming).

Fields

id: String

Tool call ID.

arguments_delta: String

Arguments delta.

ToolCallEnd

Tool call ended.

Fields

id: String

Tool call ID.

ToolResult

Tool execution result.

Fields

id: String

Tool call ID.

output: ToolOutput

Tool output.

ToolProgress

Tool execution progress.

Fields

id: String

Tool call ID.

message: String

Progress message.

progress_pct: Option<f32>

Progress percentage (0.0-1.0).

StateUpdate

State update patch.

Fields

patch: Value

JSON patch for state.

DirectiveEmitted

Directive emitted by agent.

Fields

directive: Value

Directive (serialized as Value to avoid circular dependency).

StatusUpdate

Status update.

Fields

status: String

Status message.

progress_pct: Option<f32>

Progress percentage (0.0-1.0).

UsageUpdate

Usage statistics update.

Fields

usage: Usage

Token usage.

RateLimitInfo

Rate limit information.

Fields

utilization_pct: f32

Utilization percentage (0.0-1.0).

reset_at: i64

Reset timestamp (Unix seconds).

allowed: bool

Whether request was allowed.

TaskNotification

Task notification.

Fields

task_id: String

Task ID.

kind: TaskEventKind

Event kind.

payload: Value

Event payload.

PromptSuggestion

Prompt suggestion.

Fields

suggestions: Vec<String>

Suggested prompts.

TurnComplete

Turn completed.

Fields

reason: TerminationReason

Termination reason.

Error

Error occurred.

Fields

message: String

Error message.

Implementations

impl AgentEvent

pub const fn is_final_response(&self) -> bool

Returns whether this event signals the final response.

Trait Implementations

impl Clone for AgentEvent

fn clone(&self) -> AgentEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AgentEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.