Skip to main content

StreamEvent

Enum StreamEvent 

Source
pub enum StreamEvent {
    TextDelta(String),
    ReasoningDelta(String),
    ReasoningBlockStart,
    FunctionCallStart {
        index: usize,
        call_id: String,
        name: String,
    },
    FunctionCallDelta {
        index: usize,
        delta: String,
    },
    FunctionCallDone {
        index: usize,
        arguments: String,
    },
    UsageUpdate {
        usage: Option<Value>,
        stop_reason: Option<String>,
    },
    Done(Value),
    Error(String),
}
Expand description

Events emitted during a streaming LLM response.

Variants§

§

TextDelta(String)

A chunk of text content from the assistant.

§

ReasoningDelta(String)

A chunk of reasoning/thinking content.

§

ReasoningBlockStart

A new reasoning/thinking block is starting (used to insert separators between multiple interleaved thinking blocks in a single response).

§

FunctionCallStart

A new function/tool call is starting. Fields: (index, call_id, function_name)

Fields

§index: usize
§call_id: String
§name: String
§

FunctionCallDelta

A chunk of function call arguments.

Fields

§index: usize
§delta: String
§

FunctionCallDone

Function call arguments are complete.

Fields

§index: usize
§arguments: String
§

UsageUpdate

Usage/metadata update (input_tokens, output_tokens, stop_reason).

Fields

§usage: Option<Value>
§stop_reason: Option<String>
§

Done(Value)

The complete response is available (streaming finished). Contains the full response body for final processing.

§

Error(String)

An error occurred during streaming.

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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