Enum AgentEvent 

pub enum AgentEvent {
    ReasoningDelta(String),
    TextDelta(String),
    ToolStart {
        name: String,
        id: String,
        humanized: String,
    },
    ToolBackgroundReady {
        id: String,
        request: Option<BackgroundRequest>,
    },
    ToolResult {
        name: String,
        id: String,
        output: String,
        success: bool,
        elapsed_ms: u64,
        sources: Vec<Source>,
    },
    ToolMedia {
        id: String,
        parts: Vec<ContentPart>,
        files: Vec<PathBuf>,
    },
    Attachment {
        filename: String,
        media_type: String,
        data: Vec<u8>,
    },
    AudioChunk {
        data: Vec<u8>,
        format: String,
    },
    Status(String),
    Compacted(String),
    FileDiff {
        path: String,
        diff: Vec<DiffLine>,
    },
    Usage(TokenUsage),
    Done(String),
    Cancelled,
    Error(String),
    ToolProgress {
        id: String,
        line: String,
    },
    SpawnedEvent {
        id: String,
        task: String,
        model: Option<Model>,
        event: Box<AgentEvent>,
    },
    Interrupted {
        tool_call_id: String,
        tool_name: String,
        output: String,
        payload: Option<Arc<dyn InterruptPayload>>,
    },
    CompactionNeeded {
        reason: CompactionReason,
    },
}

Events emitted by the agent turn loop as a Stream<Item = AgentEvent>.

Listeners (REPL, Slack, Telegram, etc.) receive these and render them incrementally. Consumers should handle all variants; unknown variants should be silently ignored so forward-compatibility is preserved.

Variants

ReasoningDelta(String)

Incremental reasoning token (for models that surface internal thinking).

TextDelta(String)

Incremental text token from the assistant message.

ToolStart

A tool call has started execution.

Fields

name: String

id: String

humanized: String

Human-readable summary of the arguments (for display in TUI/cards).

ToolBackgroundReady

A running tool accepts a user request to continue in the background.

Fields

id: String

request: Option<BackgroundRequest>

ToolResult

A tool has finished. The output may be truncated for display.

Fields

name: String

id: String

output: String

success: bool

elapsed_ms: u64

sources: Vec<Source>

ToolMedia

Media a finished tool call returned or names on disk, sent just before its ToolResult so clients can show it.

Fields

id: String

parts: Vec<ContentPart>

The non-text parts of the result, such as base64 images.

files: Vec<PathBuf>

Local files the result shows.

Attachment

A file the model produced in its reply, such as a generated image.

Fields

filename: String

media_type: String

data: Vec<u8>

AudioChunk

Incremental audio output chunk (raw bytes) for real-time playback.

Fields

data: Vec<u8>

format: String

Status(String)

Informational status message (compaction progress, retry attempts, etc.).

Compacted(String)

Conversation was compacted; payload is the summary text.

FileDiff

A file was modified by a tool.

Fields

path: String

diff: Vec<DiffLine>

Usage(TokenUsage)

Token usage telemetry from the provider.

Done(String)

Final terminal event — processing complete with String as the full response.

Cancelled

The user cancelled the running turn.

Error(String)

Terminal error event.

ToolProgress

Incremental output from a running tool (e.g. stdout lines from bash).

Fields

id: String

line: String

SpawnedEvent

A spawned agent produced an event while running in parallel.

Fields

id: String

task: String

model: Option<Model>

event: Box<AgentEvent>

Interrupted

A tool requested interactive input. Emitted when a turn ends with TurnStatus::Interrupted. The caller should show the appropriate picker, inject the tool result, and resume.

Fields

tool_call_id: String

tool_name: String

output: String

payload: Option<Arc<dyn InterruptPayload>>

CompactionNeeded

The conversation needs compaction but auto_compact is off. The caller should compact and call agent.start() with AgentInput::Resume.

Fields

reason: CompactionReason

Trait Implementations

impl Clone for AgentEvent

fn clone(&self) -> Self

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.