Skip to main content

AgentEvent

Enum AgentEvent 

Source
#[non_exhaustive]
pub enum AgentEvent {
Show 16 variants AgentStart, AgentEnd { messages: Vec<AgentMessage>, }, TurnStart, TurnEnd { message: AgentMessage, tool_results: Vec<ToolResultMessage>, }, MessageStart { message: AgentMessage, }, MessageUpdate { message: AgentMessage, assistant_event: Box<AssistantStreamEvent>, }, MessageEnd { message: AgentMessage, }, ToolExecutionStart { tool_call_id: String, tool_name: String, args: Value, }, ToolExecutionUpdate { tool_call_id: String, tool_name: String, args: Value, partial_result: Value, }, ToolExecutionEnd { tool_call_id: String, tool_name: String, result: Value, details: Option<Value>, is_error: bool, }, QueueUpdate { steering: Vec<String>, follow_up: Vec<String>, }, AutoRetryStart { attempt: u32, max_attempts: u32, delay_ms: u64, error_message: String, }, AutoRetryEnd { success: bool, attempt: u32, final_error: Option<String>, }, CompactionStart { reason: CompactionReason, }, CompactionEnd { reason: CompactionReason, result: Option<CompactionResult>, aborted: bool, error_message: Option<String>, }, SessionPersistError { message: String, },
}
Expand description

Events emitted during the agent loop lifecycle.

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

AgentStart

The agent loop has started.

§

AgentEnd

The agent loop has ended. No more loop events will be emitted.

Fields

§messages: Vec<AgentMessage>
§

TurnStart

A new turn (provider request/response cycle) has started.

§

TurnEnd

A turn has ended with the assistant message and any tool results.

Fields

§tool_results: Vec<ToolResultMessage>
§

MessageStart

An assistant message has started streaming.

Fields

§

MessageUpdate

An assistant message has been updated with a stream event.

Fields

§assistant_event: Box<AssistantStreamEvent>
§

MessageEnd

An assistant message has finished streaming.

Fields

§

ToolExecutionStart

Tool execution is about to begin.

Fields

§tool_call_id: String
§tool_name: String
§args: Value
§

ToolExecutionUpdate

Tool execution has produced a progress update.

Fields

§tool_call_id: String
§tool_name: String
§args: Value
§partial_result: Value
§

ToolExecutionEnd

Tool execution has completed.

Fields

§tool_call_id: String
§tool_name: String
§result: Value
§details: Option<Value>
§is_error: bool
§

QueueUpdate

Queue messages were delivered to the conversation.

Fields

§steering: Vec<String>
§follow_up: Vec<String>
§

AutoRetryStart

A retryable provider error occurred; a retry attempt is starting.

Fields

§attempt: u32
§max_attempts: u32
§delay_ms: u64
§error_message: String
§

AutoRetryEnd

A retry attempt concluded (either successfully or after exhausting attempts).

Fields

§success: bool
§attempt: u32
§final_error: Option<String>
§

CompactionStart

Compaction has started. Emitted by the harness outside the agent loop.

Fields

§

CompactionEnd

Compaction has finished. Emitted by the harness outside the agent loop.

Fields

§aborted: bool
§error_message: Option<String>
§

SessionPersistError

Session persistence failed (disk full, permissions, etc.).

Fields

§message: 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
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 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

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> 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> Same for T

Source§

type Output = T

Should always be Self
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