Struct UsageUpdate 

#[non_exhaustive]
pub struct UsageUpdate {
    pub used: u64,
    pub size: u64,
    pub cost: Option<Cost>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Context window and cost update for a 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.

used: u64

Tokens currently in context.

size: u64

Total context window size in tokens.

cost: Option<Cost>

Cumulative session cost (optional).

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 UsageUpdate

pub fn new(used: u64, size: u64) -> UsageUpdate

pub fn cost(self, cost: impl IntoOption<Cost>) -> UsageUpdate

Cumulative session cost (optional).

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

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 UsageUpdate

fn clone(&self) -> UsageUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for UsageUpdate

type Output = UsageUpdate

The corresponding v1 type.

fn into_v1( self, ) -> Result<<UsageUpdate as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonSchema for UsageUpdate

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 UsageUpdate

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

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 UsageUpdate