Skip to main content

StreamEvent

Enum StreamEvent 

Source
pub enum StreamEvent {
Show 13 variants Start { provider: &'static str, model: String, metadata: ResponseMetadata, }, TextDelta { text: String, }, ReasoningDelta { kind: ReasoningKind, text: String, }, ToolCallDelta { index: usize, id: Option<String>, name: Option<String>, arguments_delta: String, }, ToolCallProgress { index: usize, id: Option<String>, name: Option<String>, arguments_so_far: String, }, NativeToolProgress { index: usize, item_id: Option<String>, input_so_far: String, }, NativeToolCompleted { index: usize, call: NativeToolCall, }, ServerToolStatus { tool: String, call_id: Option<String>, state: ServerToolState, }, Usage { usage: Usage, }, Retry { delay: Duration, }, Retrying { attempt: u32, max_attempts: u32, delay: Duration, reason: String, }, Error { error: StreamError, }, Done { response: Box<ChatResponse>, finish_reason: Option<String>, },
}
Expand description

A provider-neutral streaming event.

Variants§

§

Start

The HTTP response was accepted and the stream is starting.

Fields

§provider: &'static str
§model: String
§

TextDelta

Incremental assistant-visible text.

Fields

§text: String
§

ReasoningDelta

Incremental reasoning summary or readable reasoning text.

Fields

§text: String
§

ToolCallDelta

Incremental tool-call data.

index identifies the tool call within the assistant message.

Fields

§index: usize
§arguments_delta: String
§

ToolCallProgress

The complete tool arguments accumulated so far for a call.

Fields

§index: usize
§arguments_so_far: String
§

NativeToolProgress

Raw custom input progress. This event is not proof of completion.

Fields

§index: usize
§item_id: Option<String>
§input_so_far: String
§

NativeToolCompleted

A completed native item. Applications must still apply cancellation and response-level scheduling policy before executing a write.

Fields

§index: usize
§

ServerToolStatus

A provider-hosted or built-in tool changed state.

Fields

§tool: String
§call_id: Option<String>
§

Usage

Usage reported during the stream. Providers may send this only at the end.

Fields

§usage: Usage
§

Retry

A server-directed SSE retry delay.

Fields

§delay: Duration
§

Retrying

The SDK scheduled a retry or reconnect with stable metadata.

Fields

§attempt: u32
§max_attempts: u32
§delay: Duration
§reason: String
§

Error

A recoverable stream error. Terminal errors are returned as Err.

Fields

§

Done

The stream completed and the SDK assembled a normal response.

Consumers that persist conversation history should append response.message, not reconstruct it from deltas.

Fields

§response: Box<ChatResponse>
§finish_reason: Option<String>

Trait Implementations§

Source§

impl Clone for StreamEvent

Source§

fn clone(&self) -> Self

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 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: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
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> 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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