Enum TurnOutcome 

pub enum TurnOutcome {
    Completed,
    Canceled,
    ProviderFailed {
        code: String,
        correlation_id: String,
    },
    ToolFailed {
        tool_id: String,
        correlation_id: String,
    },
    BudgetExceeded {
        dimension: BudgetDimension,
    },
    InterruptedAfterSideEffect {
        call_id: String,
    },
}

Typed terminal outcome of a model turn (spec §5.2). Produced ONCE by the engine; every frontend (chat, TUI, RPC, server, watcher, subagents) receives the same value and must never re-derive it from message text.

Variants

Completed

Canceled

ProviderFailed

Fields

code: String

correlation_id: String

ToolFailed

Fields

tool_id: String

correlation_id: String

BudgetExceeded

Fields

dimension: BudgetDimension

InterruptedAfterSideEffect

Fields

call_id: String

Implementations

impl TurnOutcome

pub fn correlation_id(&self) -> Option<&str>

The correlation ID tying this outcome to engine trace/log lines, when the variant carries one.

pub fn is_failure(&self) -> bool

True for outcomes that must surface as a non-success terminal state.

Trait Implementations

impl Clone for TurnOutcome

fn clone(&self) -> TurnOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurnOutcome

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TurnOutcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TurnOutcome

impl PartialEq for TurnOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TurnOutcome

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TurnOutcome