Skip to main content

StreamEvent

Enum StreamEvent 

Source
pub enum StreamEvent {
    ContentChunk(String),
    ToolCallStart {
        id: String,
        name: String,
    },
    ToolCallDelta {
        id: String,
        delta: Value,
    },
    ToolCallResult {
        id: String,
        output: Value,
    },
    FinalAnswer(String),
    Metadata {
        key: String,
        value: Value,
    },
    AwaitingApproval {
        run_id: String,
        prompt: String,
        checkpoint_id: String,
    },
    ThinkingChunk(String),
    UsageUpdate {
        input_tokens: u32,
        output_tokens: u32,
        cache_read_tokens: Option<u32>,
        cache_write_tokens: Option<u32>,
    },
}

Variants§

§

ContentChunk(String)

§

ToolCallStart

Fields

§name: String
§

ToolCallDelta

Fields

§delta: Value
§

ToolCallResult

Fields

§output: Value
§

FinalAnswer(String)

§

Metadata

Fields

§value: Value
§

AwaitingApproval

Emitted when an agent pauses at a human-in-the-loop approval gate.

The host application should present prompt to a human, collect their decision, and resume the graph from checkpoint_id.

Fields

§run_id: String

Stable identifier for this execution run.

§prompt: String

Human-readable description of what the agent wants to do.

§checkpoint_id: String

Opaque checkpoint identifier — pass back to resume the graph.

§

ThinkingChunk(String)

Model reasoning / scratchpad text (Anthropic extended thinking, OpenAI o-series).

§

UsageUpdate

Token consumption update emitted after each LLM response.

Fields

§input_tokens: u32
§output_tokens: u32
§cache_read_tokens: Option<u32>
§cache_write_tokens: Option<u32>

Trait Implementations§

Source§

impl Clone for StreamEvent

Source§

fn clone(&self) -> StreamEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamEvent

Source§

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

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

impl PartialEq for StreamEvent

Source§

fn eq(&self, other: &StreamEvent) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 StructuralPartialEq for StreamEvent

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V