Enum IdleStopReason 

#[non_exhaustive]
pub enum IdleStopReason {
    EndTurn,
    MaxTokens,
    MaxTurnRequests,
    Refusal,
    Cancelled,
    Error(ErrorStopReason),
    Other(OtherStopReason),
}

Available on crate feature unstable_subagents only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Reason a child’s foreground work stopped, reported on its idle state snapshot.

Tagged by stopReason and flattened into IdleStateUpdate, so the snapshot matches v2’s idle state_update, including its handling of unknown values. The known values are those of StopReason plus error. A child has no prompt response of its own, so this snapshot is the only place to report that its work failed. The prompt response keeps StopReason and reports failures as JSON-RPC errors.

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.

EndTurn

The work ended successfully.

MaxTokens

The work ended because the agent reached the maximum number of tokens.

MaxTurnRequests

The work ended because the agent reached the maximum number of allowed agent requests.

Refusal

The work ended because the agent refused to continue.

Cancelled

The work was cancelled.

Error(ErrorStopReason)

The work ended because something failed.

Other(OtherStopReason)

Custom or future stop reason.

Values beginning with _ are reserved for implementation-specific extensions. Other unknown values are reserved for future ACP variants.

Trait Implementations

impl Clone for IdleStopReason

fn clone(&self) -> IdleStopReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdleStopReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IdleStopReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IdleStopReason

impl From<ErrorStopReason> for IdleStopReason

fn from(value: ErrorStopReason) -> IdleStopReason

Converts to this type from the input type.

impl JsonSchema for IdleStopReason

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for IdleStopReason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for IdleStopReason

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 IdleStopReason