Skip to main content

AgentEvent

Enum AgentEvent 

Source
pub enum AgentEvent {
Show 15 variants UserInput { text: String, }, ToolResult { segments: Vec<DisplaySegment>, }, SubscriptionEvent { name: String, text: String, }, OAuthRequired { auth_url: String, }, CompactionApplied, CompletionStarted, TextChunk { text: String, }, ThinkingStarted, ThinkingChunk { text: String, }, ThinkingEnded, ToolCall { name: String, args: Value, display_as: Option<String>, }, CompletionFinished { usage: Option<Usage>, }, UserChoiceRequired { choice: UserChoice, }, UserChoiceDismissed { choice_id: String, }, Info { text: String, },
}
Expand description

A single observable event from a thread’s execution.

This type is Clone and carries no provider-specific generics, so embeddings can fan events out to multiple subscribers or buffer them freely.

Variants§

§

UserInput

A user text input was accepted into the thread’s history.

Fields

§text: String
§

ToolResult

A tool result (from an asynchronously dispatched tool call) was accepted into the thread’s history, or a synchronous tool produced a result inline. Clients should render the first segment type they support; the raw text is always included as a trailing Text segment.

Fields

§

SubscriptionEvent

A subscription event or thread report was injected into this thread.

Fields

§name: String
§text: String
§

OAuthRequired

A tool server requires OAuth authorization before it can proceed.

Fields

§auth_url: String
§

CompactionApplied

A compaction summary replaced the beginning of the in-memory history.

§

CompletionStarted

A completion round is about to stream.

§

TextChunk

A chunk of assistant text.

Fields

§text: String
§

ThinkingStarted

The model started reasoning.

§

ThinkingChunk

A chunk of reasoning text.

Fields

§text: String
§

ThinkingEnded

The model finished reasoning.

§

ToolCall

The model called a tool. display_as is the pretty-printed form from the tool’s display script, when available.

Fields

§name: String
§args: Value
§display_as: Option<String>
§

CompletionFinished

The completion round finished (its turn is synced to the store by the time this event is observed). usage is the token usage reported by the provider, if any.

Fields

§usage: Option<Usage>
§

UserChoiceRequired

A tool server requested a user choice. The choice has already been persisted when this event is emitted.

Fields

§choice: UserChoice
§

UserChoiceDismissed

A pending user choice became moot and has already been removed from persistent state.

Fields

§choice_id: String
§

Info

Human-readable progress/diagnostic information (retries, warnings).

Fields

§text: String

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

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: Sized + 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: Sized + 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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