Skip to main content

ToolLoopEvent

Enum ToolLoopEvent 

Source
pub enum ToolLoopEvent {
    IterationStart {
        iteration: u32,
        message_count: usize,
    },
    ToolExecutionStart {
        call_id: String,
        tool_name: String,
        arguments: Value,
    },
    ToolExecutionEnd {
        call_id: String,
        tool_name: String,
        result: ToolResult,
        duration: Duration,
    },
    LlmResponseReceived {
        iteration: u32,
        has_tool_calls: bool,
        text_length: usize,
    },
    LoopDetected {
        tool_name: String,
        consecutive_count: u32,
        action: LoopAction,
    },
}
Expand description

Events emitted during tool loop execution for observability.

These events allow UIs to show real-time progress:

  • “Iteration 3 starting”
  • “Calling tool search…”
  • “Tool search completed in 200ms”

§Example

use llm_stack_core::tool::{ToolLoopConfig, ToolLoopEvent};
use std::sync::Arc;

let config = ToolLoopConfig {
    on_event: Some(Arc::new(|event| {
        match event {
            ToolLoopEvent::IterationStart { iteration, .. } => {
                println!("Starting iteration {iteration}");
            }
            ToolLoopEvent::ToolExecutionStart { tool_name, .. } => {
                println!("Calling {tool_name}...");
            }
            ToolLoopEvent::ToolExecutionEnd { tool_name, duration, .. } => {
                println!("{tool_name} completed in {duration:?}");
            }
            _ => {}
        }
    })),
    ..Default::default()
};

Variants§

§

IterationStart

A new iteration of the tool loop is starting.

Fields

§iteration: u32

The iteration number (1-indexed).

§message_count: usize

Number of messages in the conversation so far.

§

ToolExecutionStart

About to execute a tool.

Fields

§call_id: String

The tool call ID from the LLM.

§tool_name: String

Name of the tool being called.

§arguments: Value

Arguments passed to the tool.

§

ToolExecutionEnd

Tool execution completed.

Fields

§call_id: String

The tool call ID from the LLM.

§tool_name: String

Name of the tool that was called.

§result: ToolResult

The result from the tool.

§duration: Duration

How long the tool took to execute.

§

LlmResponseReceived

LLM response received for this iteration.

Fields

§iteration: u32

The iteration number (1-indexed).

§has_tool_calls: bool

Whether the response contains tool calls.

§text_length: usize

Length of any text content in the response.

§

LoopDetected

A tool call loop was detected.

Emitted when the same tool is called with identical arguments for threshold consecutive times. Only emitted when LoopDetectionConfig is configured.

Fields

§tool_name: String

Name of the tool being called repeatedly.

§consecutive_count: u32

Number of consecutive identical calls detected.

§action: LoopAction

The action being taken in response.

Trait Implementations§

Source§

impl Clone for ToolLoopEvent

Source§

fn clone(&self) -> ToolLoopEvent

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 ToolLoopEvent

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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