Skip to main content

StreamDelta

Struct StreamDelta 

Source
pub struct StreamDelta {
    pub content: String,
    pub thinking: Option<String>,
    pub usage: Option<Usage>,
    pub model: Option<String>,
    pub stop_reason: Option<StopReason>,
    pub is_final: bool,
}
Expand description

An incremental chunk from a streaming language model response.

Fields§

§content: String

Incremental text content (may be empty on non-content events).

§thinking: Option<String>

Extended-thinking / reasoning text emitted on this chunk. Streamed alongside (or before) content on providers that expose chain-of-thought as a distinct content block:

  • Bedrock Converse: populated from ContentBlockDelta::Reasoning events (gpt-oss, DeepSeek R1, Magistral, MiniMax M2, Nemotron-super on the Runtime endpoint).

None on the OpenAI Chat Completions surface (reasoning isn’t streamed per OpenAI spec — it shows up only in completion_tokens_details.reasoning_tokens accounting), and on adapters that haven’t been extended to surface reasoning yet (Anthropic thinking blocks, Mantle Responses reasoning events).

§usage: Option<Usage>

Token usage statistics. Presence and timing depend on the provider:

  • Anthropic: populated on message_delta events (mid-stream, sometimes on multiple events as token counts evolve). The final message_stop event carries None.
  • OpenAI / Ollama: populated only on the final pre-[DONE] chunk, because we set stream_options.include_usage = true on the request. Without that flag the field would be None for every chunk.
  • Default generate_stream impl (non-streaming providers wrapped into a one-item stream): populated on the single delta which is also is_final.

Consumers that need cost tracking should accumulate or take the last non-None value rather than expect usage on every chunk.

§model: Option<String>

The model name — typically only present on the first chunk.

§stop_reason: Option<StopReason>

Normalized reason generation stopped — populated on whichever chunk carries the wire-level stop signal:

  • OpenAI Chat Completions: the final content chunk with a non-null finish_reason.
  • Anthropic Messages: the message_delta event (which also carries final usage).
  • Bedrock Converse: the MessageStop event (precedes the terminating Metadata chunk that carries usage).
  • Mantle Responses: the response.completed event (also carries usage). response.incomplete events with recoverable reasons (max_output_tokens, content_filter) surface their stop reason here too instead of being raised as errors.

None on intermediate content deltas and on providers that don’t surface this on streams. Downstream consumers comparing against max_tokens should prefer this field when present rather than inferring truncation from output-token counts.

§is_final: bool

Whether this is the final chunk in the stream.

Trait Implementations§

Source§

impl Clone for StreamDelta

Source§

fn clone(&self) -> StreamDelta

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 StreamDelta

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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