Struct IdleStateUpdate 

#[non_exhaustive]
pub struct IdleStateUpdate {
    pub stop_reason: Option<StopReason>,
    pub usage: Option<Usage>,
    pub meta: Option<Map<String, Value>>,
}

The child is ready to process another prompt.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stop_reason: Option<StopReason>

Reason foreground work stopped. Optional; omitted or null means not reported.

usage: Option<Usage>

Available on crate feature unstable_end_turn_token_usage only.

UNSTABLE Token usage for completed foreground work.

Optional; omitted or null means not reported.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP for additional metadata. Implementations MUST NOT make assumptions about values at these keys. Optional; omitted and null mean no metadata for this state snapshot.

Implementations

impl IdleStateUpdate

pub fn new() -> IdleStateUpdate

Available on crate feature unstable_subagents only.

Builds an empty idle state.

pub fn stop_reason( self, stop_reason: impl IntoOption<StopReason>, ) -> IdleStateUpdate

Available on crate feature unstable_subagents only.

Reason foreground work stopped.

pub fn usage(self, usage: impl IntoOption<Usage>) -> IdleStateUpdate

Available on crate features unstable_end_turn_token_usage and unstable_subagents only.

Token usage for completed foreground work.

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> IdleStateUpdate

Available on crate feature unstable_subagents only.

Reserved metadata for extensions.

Trait Implementations

impl Clone for IdleStateUpdate

fn clone(&self) -> IdleStateUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdleStateUpdate

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

Formats the value using the given formatter.

impl Default for IdleStateUpdate

fn default() -> IdleStateUpdate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IdleStateUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for IdleStateUpdate

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 IdleStateUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for IdleStateUpdate

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 IdleStateUpdate