Skip to main content

CompletionBuilder

Struct CompletionBuilder 

Source
pub struct CompletionBuilder { /* private fields */ }
Expand description

Reassembles a stream of TextDeltas back into a Completion — the inverse of completion_deltas, for a caller that consumed a stream incrementally (relaying it to a client, say) and still wants the whole answer at the end: to log, to persist, to hand to the tool loop.

§Semantics

  • TextDelta::Text pieces concatenate in order.
  • TextDelta::Reasoning is dropped: reasoning is not part of a completion.
  • TextDelta::ToolCallFinished fills tool_calls in index order; argument chunks and starts are informational here, since the finished call carries the reassembled form. A call whose finish never arrived (the stream died mid-call) leaves no trace — a half-finished call is not a call the tool loop may run.
  • TextDelta::Usage is last-wins, whole replacement.
  • TextDelta::Finish supplies model (empty when the stream ended without one).
  • json is always None: structured output is a complete feature — the parsed value comes from validating the whole answer against the prompt’s schema, which a stream that relayed itself away never promised. A streaming caller wanting a value parses and validates the reassembled text itself.

Implementations§

Source§

impl CompletionBuilder

Source

pub fn push(&mut self, delta: &TextDelta)

Folds one delta in. Cheap; call it for every item the stream yields.

Source

pub fn finish_reason(&self) -> Option<&FinishReason>

Why the stream ended, where it sent a Finish — None for a stream that is still open or died without one.

Source

pub fn finish(self) -> Completion

The completion the deltas add up to: text concatenated, tool calls from their finishes in index order, usage last-wins, model from the Finish, json None (see the type’s docs).

Trait Implementations§

Source§

impl Debug for CompletionBuilder

Source§

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

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

impl Default for CompletionBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> Same for T

Source§

type Output = T

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