Skip to main content

TerminationReason

Enum TerminationReason 

Source
pub enum TerminationReason {
    Complete,
    StopCondition {
        reason: Option<String>,
    },
    MaxIterations {
        limit: u32,
    },
    LoopDetected {
        tool_name: String,
        count: u32,
    },
    Timeout {
        limit: Duration,
    },
}
Expand description

Why a tool loop terminated.

Used for observability and debugging. Each variant captures specific information about why the loop ended.

§Example

use llm_stack::tool::TerminationReason;
use std::time::Duration;

match reason {
    TerminationReason::Complete => println!("Task completed naturally"),
    TerminationReason::StopCondition { reason } => {
        println!("Custom stop: {}", reason.as_deref().unwrap_or("no reason"));
    }
    TerminationReason::MaxIterations { limit } => {
        println!("Hit iteration limit: {limit}");
    }
    TerminationReason::LoopDetected { tool_name, count } => {
        println!("Stuck calling {tool_name} {count} times");
    }
    TerminationReason::Timeout { limit } => {
        println!("Exceeded timeout: {limit:?}");
    }
}

Variants§

§

Complete

LLM returned a response with no tool calls (natural completion).

§

StopCondition

Custom stop condition returned StopDecision::Stop or StopDecision::StopWithReason.

Fields

§reason: Option<String>

The reason provided via StopDecision::StopWithReason, if any.

§

MaxIterations

Hit the max_iterations limit.

Fields

§limit: u32

The configured limit that was reached.

§

LoopDetected

Loop detection triggered with LoopAction::Stop.

Fields

§tool_name: String

Name of the tool being called repeatedly.

§count: u32

Number of consecutive identical calls.

§

Timeout

Wall-clock timeout exceeded.

Fields

§limit: Duration

The configured timeout that was exceeded.

Trait Implementations§

Source§

impl Clone for TerminationReason

Source§

fn clone(&self) -> TerminationReason

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 TerminationReason

Source§

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

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

impl PartialEq for TerminationReason

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for TerminationReason

Source§

impl StructuralPartialEq for TerminationReason

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