Skip to main content

ExitReason

Enum ExitReason 

Source
#[non_exhaustive]
pub enum ExitReason { Complete, MaxTurns, BudgetExhausted, CircuitBreaker, Timeout, InterceptorHalt { reason: String, }, Error, SafetyStop { reason: String, }, AwaitingApproval, Custom(String), }
Expand description

Why an operator invocation ended. The caller needs to know this to decide what happens next (retry? continue? escalate?).

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Complete

Model produced a final text response (natural completion).

§

MaxTurns

Hit the max_turns limit.

§

BudgetExhausted

Hit the cost budget (max_cost) or the tool-call step limit (max_tool_calls). Use BudgetEvent sink notifications to distinguish the two causes.

§

CircuitBreaker

Circuit breaker tripped (consecutive failures).

§

Timeout

Wall-clock timeout.

§

InterceptorHalt

Interceptor/middleware halted execution.

Fields

§reason: String

The reason the interceptor halted execution.

§

Error

Unrecoverable error during execution.

§

SafetyStop

Provider safety system stopped generation (HTTP 200, content filtered).

Semantically distinct from Error (not a transport or execution failure) and Complete (model did not finish naturally). Arrives via StopReason::ContentFilter in the provider response — the provider acknowledged the request but refused to complete it. Not retriable without modification to the context or request.

Fields

§reason: String

Human-readable reason string supplied by the provider or runtime.

§

AwaitingApproval

One or more tool calls require human approval before execution. The calling layer should inspect OperatorOutput::effects for Effect::ToolApprovalRequired entries, obtain approval, then either execute the tools and re-enter the loop, or inject a denial message and re-enter.

§

Custom(String)

Future exit reasons.

Trait Implementations§

Source§

impl Clone for ExitReason

Source§

fn clone(&self) -> ExitReason

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 ExitReason

Source§

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

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

impl<'de> Deserialize<'de> for ExitReason

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ExitReason

Source§

fn eq(&self, other: &ExitReason) -> 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 Serialize for ExitReason

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ExitReason

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, 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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,