Skip to main content

AgentEvent

Enum AgentEvent 

Source
pub enum AgentEvent {
Show 15 variants RunStarted { session_id: SessionId, }, TurnStarted { session_id: SessionId, turn_id: TurnId, }, InputAccepted { session_id: SessionId, items: Vec<Item>, }, ContentDelta(Delta), ToolCallRequested(ToolCallPart), ToolResultReceived(ToolResultPart), ApprovalRequired(ApprovalRequest), ApprovalResolved { approved: bool, }, ToolCatalogChanged(ToolCatalogEvent), MutationStarted { session_id: SessionId, turn_id: Option<TurnId>, mutator: String, point: MutationPoint, }, MutationFinished { session_id: SessionId, turn_id: Option<TurnId>, mutator: String, dirty: bool, metadata: MetadataMap, }, UsageUpdated(Usage), Warning { message: String, }, RunFailed { message: String, }, TurnFinished(TurnResult),
}
Expand description

Lifecycle and streaming events emitted by the LoopDriver.

Observers (see LoopObserver) receive these events in the order they occur. They are useful for building UIs, logging, or telemetry.

Variants§

§

RunStarted

The agent run has been initialised.

Fields

§session_id: SessionId
§

TurnStarted

A new model turn is starting.

Fields

§session_id: SessionId
§turn_id: TurnId
§

InputAccepted

User input has been accepted into the pending queue.

Fields

§session_id: SessionId
§items: Vec<Item>
§

ContentDelta(Delta)

Incremental content delta from the model.

§

ToolCallRequested(ToolCallPart)

The model has requested a tool call.

§

ToolResultReceived(ToolResultPart)

A tool call’s result has landed in the transcript.

Fires once per Part::ToolResult that’s appended, including the synthetic placeholder that’s pushed when a tool is detached to the background — the real result fires a second event with the same ToolResultPart::call_id once the background task completes. Cancellation/denial paths (auth cancelled, approval denied) also emit this with is_error = true.

Correlate with the matching AgentEvent::ToolCallRequested via call_id.

§

ApprovalRequired(ApprovalRequest)

A tool call requires explicit user approval before execution.

§

ApprovalResolved

An approval interrupt has been resolved.

Fields

§approved: bool
§

ToolCatalogChanged(ToolCatalogEvent)

The available tool catalog changed and will be reflected on the next model request.

§

MutationStarted

A LoopMutator is about to run at one of the mutation points. mutator is a stable label the implementation chooses for itself.

Fields

§session_id: SessionId
§turn_id: Option<TurnId>
§mutator: String
§

MutationFinished

A LoopMutator has finished running. dirty indicates whether the transcript was modified; metadata carries mutator-specific extras (e.g. compaction reason, replaced item count).

Fields

§session_id: SessionId
§turn_id: Option<TurnId>
§mutator: String
§dirty: bool
§metadata: MetadataMap
§

UsageUpdated(Usage)

Updated token usage statistics.

§

Warning

Non-fatal warning (e.g. a tool failure that was recovered from).

Fields

§message: String
§

RunFailed

The agent run has failed with an unrecoverable error.

Fields

§message: String
§

TurnFinished(TurnResult)

A turn has finished (successfully, via cancellation, etc.).

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
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> 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> 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.
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,