Enum ToolLoopEvent 

#[non_exhaustive]
pub enum ToolLoopEvent {
    Delta {
        step: usize,
        delta: TextDelta,
    },
    ToolResult {
        step: usize,
        call: ToolCall,
        result: ToolResult,
    },
    StepFinished {
        step: usize,
        usage: StepUsage,
    },
    Done(ToolLoopOutcome),
}

One thing a streamed tool loop did (issue #859): the item type of run_tool_loop_stream, produced in the order the work happened. Within one step: every TextDelta as it arrived, then one result per executed call, then the step’s StepUsage — the same bookkeeping, in the same order, the buffered loop records into ToolLoopOutcome::steps. A loop that finishes ends with exactly one Self::Done; one that fails ends with the Err instead, and no Done follows an error.

#[non_exhaustive]: the loop is new and what it can report will grow.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Delta

A TextDelta straight off the model’s stream, forwarded the moment it arrived — including TextDelta::Reasoning, which the completion rebuilt for the loop’s own decisions does not carry.

Fields

step: usize

The step the delta belongs to: 0-based, the position its StepUsage takes in ToolLoopOutcome::steps.

delta: TextDelta

The delta itself, exactly as the model yielded it.

ToolResult

An executed tool call and the result the model will be shown — the same ToolResult the buffered loop feeds back, a tool-level failure included. Emitted after the call ran, before the next one starts.

Fields

step: usize

The step whose completion asked for the call.

call: ToolCall

The call as the model asked for it.

result: ToolResult

What running it produced, or the error fed back instead.

StepFinished

A model call finished and this is what it cost — the same entry the buffered loop appends to ToolLoopOutcome::steps. One per model call, before that call’s tools run.

Fields

step: usize

The step that finished, 0-based as in Self::Delta.

usage: StepUsage

The usage the call reported.

Done(ToolLoopOutcome)

The loop is over: the same outcome run_tool_loop returns for the same run. Always the stream’s last item on success.

Trait Implementations

impl Clone for ToolLoopEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolLoopEvent

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

Formats the value using the given formatter.

impl PartialEq for ToolLoopEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolLoopEvent