Skip to main content

AgentEvent

Enum AgentEvent

pub enum AgentEvent {
Show 18 variants
    RunStarted(RunStarted),
    ContextBuilt(ContextBuilt),
    ModelStarted(ModelStarted),
    TextDelta(TextDelta),
    ToolCallStarted(ToolCallStarted),
    ToolCallDelta(ToolCallDelta),
    ToolCallCompleted(ToolCallCompleted),
    ToolExecutionStarted(ToolExecutionStarted),
    ToolExecutionFinished(ToolExecutionFinished),
    AssistantMessageCommitted(MessageCommitted),
    ToolMessageCommitted(MessageCommitted),
    UsageRecorded(UsageRecorded),
    CacheMetrics(CacheMetrics),
    RunCompleted(RunCompleted),
    RunFailed(RunFailed),
    RunCancelled(RunCancelled),
    DoomLoopDetected(DoomLoopDetected),
    CompactionCircuitOpened(CompactionCircuitOpened),
}

Expand description

Event emitted during agent runtime execution.

Variants§

RunStarted(RunStarted)

Run has started.

ContextBuilt(ContextBuilt)

Context has been built.

ModelStarted(ModelStarted)

Model call has started.

TextDelta(TextDelta)

Text delta from model.

ToolCallStarted(ToolCallStarted)

Tool call has started.

ToolCallDelta(ToolCallDelta)

Tool call arguments delta.

ToolCallCompleted(ToolCallCompleted)

Tool call has completed.

ToolExecutionStarted(ToolExecutionStarted)

Tool execution has started.

ToolExecutionFinished(ToolExecutionFinished)

Tool execution has finished.

AssistantMessageCommitted(MessageCommitted)

Assistant message has been committed to store.

ToolMessageCommitted(MessageCommitted)

Tool message has been committed to store.

UsageRecorded(UsageRecorded)

Usage has been recorded.

CacheMetrics(CacheMetrics)

Prompt cache metrics from a single model call.

RunCompleted(RunCompleted)

Run has completed successfully.

RunFailed(RunFailed)

Run has failed.

RunCancelled(RunCancelled)

Run has been cancelled.

DoomLoopDetected(DoomLoopDetected)

Doom loop has been detected.

CompactionCircuitOpened(CompactionCircuitOpened)

Compaction circuit breaker has opened due to repeated failures.

Implementations§

impl AgentEvent

pub fn run_id(&self) -> RunId

Returns the run identifier for any event variant without pattern matching.

pub fn is_terminal(&self) -> bool

Returns true when this event signals a terminal run state.

Trait Implementations§

impl Clone for AgentEvent

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

impl Debug for AgentEvent

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

Formats the value using the given formatter. Read more

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

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

Auto Trait Implementations§

impl Freeze for AgentEvent

impl RefUnwindSafe for AgentEvent

impl Send for AgentEvent

impl Sync for AgentEvent

impl Unpin for AgentEvent

impl UnsafeUnpin for AgentEvent

impl UnwindSafe for AgentEvent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.