Enum LoopState 

pub enum LoopState {
    Starting,
    ContextAssembly,
    ProviderProjection,
    ModelStreaming,
    StreamIntervention,
    ToolPlanning,
    Approval,
    ToolDenied,
    ToolExecution,
    Interrupted,
    WaitingForResume,
    Compaction,
    Continue,
    Recovery,
    Completed,
    Cancelled,
    Failed,
}

Names the finite phases of the SDK run loop. Use it in state tables, journal records, and tests to describe where a run is paused or executing; the enum is a marker only and side effects happen in the driver transition that enters the phase.

Variants

Starting

The run has been accepted and initial package, policy, and registry checks are beginning.

ContextAssembly

The runtime is collecting context contributions before anything is shown to a provider.

ProviderProjection

Context has been admitted and is being projected into the provider-visible request shape.

ModelStreaming

A provider call is active and model deltas may be emitted.

StreamIntervention

Stream rules are inspecting, interrupting, or transforming an active model stream.

ToolPlanning

The runtime is interpreting provider output into candidate tool calls or loop actions.

Approval

A tool or extension action is waiting for an approval decision before execution.

ToolDenied

Policy or approval denied a requested tool before the executor was started.

ToolExecution

A journal-backed tool intent has been recorded and the configured executor may be running.

Interrupted

Cancellation, timeout, stream policy, or host intervention interrupted active work.

WaitingForResume

The run is suspended and requires a wake, resume signal, or durable replay input.

Compaction

The runtime is compacting context or summaries before continuing the loop.

Continue

The current iteration completed and the driver is preparing another loop iteration.

Recovery

Replay, repair, or reconciliation is resolving an incomplete or uncertain effect.

Completed

The run reached a successful terminal result.

Cancelled

The run reached a cancellation terminal result.

Failed

The run reached an unrecoverable failure terminal result.

Implementations

impl LoopState

pub const ALL: [Self; 17]

Constant value for the application::loop_state contract. Use it to keep SDK records and tests aligned on the same stable value.

pub fn all() -> &'static [Self]

Returns the all currently held by this value. This is state-table metadata only and does not advance a run or mutate loop state.

pub fn contract_name(self) -> &'static str

Returns the stable contract spelling for this loop state. This is a pure mapping used by fixtures and diagnostics; it does not advance the loop.

pub fn is_terminal(self) -> bool

Reports whether this value is terminal. The check is pure and does not mutate SDK or host state.

pub fn can_carry_terminal_result(self) -> bool

Returns whether can carry terminal result applies for this state. This is state-table metadata only and does not advance a run or mutate loop state.

pub fn requires_cancel_transition(self) -> bool

Returns whether requires cancel transition applies for this state. This is state-table metadata only and does not advance a run or mutate loop state.

Trait Implementations

impl Clone for LoopState

fn clone(&self) -> LoopState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LoopState

impl Debug for LoopState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoopState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LoopState

impl Hash for LoopState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LoopState

fn cmp(&self, other: &LoopState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LoopState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for LoopState

fn partial_cmp(&self, other: &LoopState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LoopState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LoopState