Struct IdleStateUpdate 

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

Available on crate feature unstable_protocol_v2 only.

The agent is not currently processing work in the session.

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>

Indicates why the agent stopped processing active session work.

Optional. Omitted or null both mean the agent is not reporting a stop reason. Agents SHOULD include this when the idle transition ends active work.

usage: Option<Usage>

Available on crate feature unstable_end_turn_token_usage only.

UNSTABLE

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

Token usage for completed session work.

Optional. Omitted or null both mean the agent is not reporting token usage for this state update.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl IdleStateUpdate

pub fn new() -> IdleStateUpdate

Builds IdleStateUpdate with the required fields set; optional fields start unset or empty.

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

Indicates why the agent stopped processing active session work.

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

Available on crate feature unstable_end_turn_token_usage only.

UNSTABLE

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

Token usage for completed session work.

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

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

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

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 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