Struct Usage 

#[non_exhaustive]
pub struct Usage {
    pub total_tokens: u64,
    pub input_tokens: u64,
    pub output_tokens: u64,
    pub thought_tokens: Option<u64>,
    pub cached_read_tokens: Option<u64>,
    pub cached_write_tokens: Option<u64>,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

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

Token usage for the foreground work that just completed, not cumulative for 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.

total_tokens: u64

Sum of all token types for the completed work.

input_tokens: u64

Input tokens for the completed work.

output_tokens: u64

Output tokens for the completed work.

thought_tokens: Option<u64>

Thought/reasoning tokens for the completed work.

Omitted and null are equivalent and mean the count is not reported.

cached_read_tokens: Option<u64>

Cache read tokens for the completed work.

Omitted and null are equivalent and mean the count is not reported.

cached_write_tokens: Option<u64>

Cache write tokens for the completed work.

Omitted and null are equivalent and mean the count is not reported.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Implementations

impl Usage

pub fn new(total_tokens: u64, input_tokens: u64, output_tokens: u64) -> Self

Available on crate feature unstable_end_turn_token_usage only.

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

pub fn thought_tokens(self, thought_tokens: impl IntoOption<u64>) -> Self

Available on crate feature unstable_end_turn_token_usage only.

Thought/reasoning tokens for the completed work.

pub fn cached_read_tokens( self, cached_read_tokens: impl IntoOption<u64>, ) -> Self

Available on crate feature unstable_end_turn_token_usage only.

Cache read tokens for the completed work.

pub fn cached_write_tokens( self, cached_write_tokens: impl IntoOption<u64>, ) -> Self

Available on crate feature unstable_end_turn_token_usage only.

Cache write tokens for the completed work.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

Available on crate feature unstable_end_turn_token_usage only.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Trait Implementations

impl Clone for Usage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Usage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Usage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Usage

impl JsonSchema for Usage

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 Usage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Usage

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 Usage