Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    Unknown,
    Stop,
    MaxTokens,
    ToolUse,
    ContentFilter,
    LoopDetected,
    BudgetExceeded,
    PolicyBlocked,
    IdentityRejected,
    SessionClosed,
    Other,
}

Why an agent execution step (or session) stopped.

Variants (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.

Unknown

Unknown / not reported.

Stop

Natural completion (provider stop).

MaxTokens

Provider truncated at max tokens.

ToolUse

Stopped to invoke a tool.

ContentFilter

Provider content filter.

LoopDetected

AgentVisor AI loop breaker tripped (Module A).

BudgetExceeded

Action/token budget exhausted (Module B).

PolicyBlocked

Policy engine blocked the action (Module B).

IdentityRejected

NHI identity validation rejected the caller (Module D).

SessionClosed

Session explicitly closed.

Other

Other (see stop_reason free text).

Round-29 F7: #[serde(other)] makes this the deserialize fallback for any unrecognised variant. Heterogeneous cluster upgrades (harness-N publishing a new stop reason variant, harness-N-1 reading it back from the bridge during recovery) would otherwise fail the whole event parse — dropping evidence and breaking chain reconstruction on stragglers. Forward-compat: a peer emitter that adds "FutureVariant" deserializes to Other; re-serialization emits "Other" (lossy on the specific variant name, but the free-text stop_reason field is the intended carrier for that detail anyway).

Implementations

impl StopReason

pub fn id(self) -> u8

Numeric stop_reason_id for the wire format.

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

Canonical caption for the wire format.

pub fn from_id(id: u8) -> Self

Parse a numeric id back into a reason (inbound tolerance: unknown ids map to Unknown, never an error — forward compatibility).

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> StopReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StopReason

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StopReason

impl Eq for StopReason

impl StructuralPartialEq for StopReason