Skip to main content

AgentEvent

Enum AgentEvent 

Source
#[non_exhaustive]
pub enum AgentEvent { TurnStart, TextDelta { delta: String, }, ThinkingDelta { delta: String, }, ReasoningComplete { blocks: Vec<ReasoningBlock>, }, ToolCallStarted { name: String, }, ToolCall { call: ToolCall, provenance: ToolProvenance, summary_fields: Vec<String>, }, ToolResult { result: MessageToolResult, }, TurnEnd { stop_reason: StopReason, usage: Usage, }, Error { message: String, }, }
Expand description

Events emitted during a turn for streaming.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

TurnStart

Turn has started.

§

TextDelta

A text delta was received from the provider.

Fields

§delta: String

The text chunk.

§

ThinkingDelta

A transient thinking/reasoning delta was received from the provider.

Thinking deltas are live UI preview data. They must not be persisted as normal conversation history or included in the final assistant text.

Fields

§delta: String

The thinking text chunk.

§

ReasoningComplete

Emitted once per provider response, before TurnEnd, when the response carried reasoning blocks. Durable replay payload; never display content.

Fields

§blocks: Vec<ReasoningBlock>

Provider-native reasoning blocks in stream order.

§

ToolCallStarted

Tool call detected: parameters still streaming.

Fields

§name: String

Name of the tool being called.

§

ToolCall

A tool call was requested.

Fields

§call: ToolCall

The tool call details.

§provenance: ToolProvenance

The provenance of the tool being called.

§summary_fields: Vec<String>

Fields to display in the TUI summary (from tool summary_fields()).

§

ToolResult

A tool call completed.

Fields

§result: MessageToolResult

The tool result.

§

TurnEnd

Turn has ended.

Fields

§stop_reason: StopReason

Why the turn ended.

§usage: Usage

Token usage for this turn.

§

Error

An error occurred.

Fields

§message: String

Error message.

Trait Implementations§

Source§

impl Clone for AgentEvent

Source§

fn clone(&self) -> AgentEvent

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 AgentEvent

Source§

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

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

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

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 PartialEq for AgentEvent

Source§

fn eq(&self, other: &AgentEvent) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for AgentEvent

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
Source§

impl StructuralPartialEq for AgentEvent

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.