Skip to main content

AgentStreamEvent

Enum AgentStreamEvent 

Source
#[non_exhaustive]
pub enum AgentStreamEvent { Started { agent: String, }, TurnStarted { turn: u32, }, Model { turn: u32, event: ModelStreamEvent, }, CallableStarted { turn: u32, kind: CallableKind, call: ToolCall, }, CallableCompleted { turn: u32, kind: CallableKind, call_id: String, name: String, success: bool, }, UsageUpdated { usage: Usage, }, Completed { outcome: AgentOutcome, }, }
Expand description

One real-time event from the canonical Agent execution loop.

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

Started

The Agent execution started.

Fields

§agent: String

Stable local Agent name.

§

TurnStarted

A model turn started.

Fields

§turn: u32

One-based turn number.

§

Model

One provider-neutral model streaming event.

Fields

§turn: u32

One-based owning turn.

§event: ModelStreamEvent

Canonical event accepted by the model stream accumulator.

§

CallableStarted

A Tool or child Agent call started.

Fields

§turn: u32

One-based owning turn.

§kind: CallableKind

Callable boundary.

§call: ToolCall

Canonical model-emitted call.

§

CallableCompleted

A Tool or child Agent call reached a recoverable terminal result.

Fields

§turn: u32

One-based owning turn.

§kind: CallableKind

Callable boundary.

§call_id: String

Model-emitted call identity.

§name: String

Model-facing callable name.

§success: bool

Whether execution produced a successful output.

§

UsageUpdated

Shared run-tree resource usage changed.

Fields

§usage: Usage

Latest cumulative usage snapshot.

§

Completed

The Agent reached a terminal model response.

Fields

§outcome: AgentOutcome

Complete canonical outcome.

Trait Implementations§

Source§

impl Clone for AgentStreamEvent

Source§

fn clone(&self) -> AgentStreamEvent

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 AgentStreamEvent

Source§

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

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

impl<'de> Deserialize<'de> for AgentStreamEvent

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 AgentStreamEvent

Source§

fn eq(&self, other: &AgentStreamEvent) -> 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 AgentStreamEvent

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 AgentStreamEvent

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.