Struct Usage 

pub struct Usage {
    pub tokens: Option<TokenUsage>,
    pub cost: Option<CostUsage>,
    pub metadata: BTreeMap<String, Value>,
}

Token and cost usage reported by a model provider for a single turn.

Reporters and compaction triggers inspect Usage to log progress, enforce budgets, and decide when to compact the transcript.

Example

use agentkit_core::{TokenUsage, Usage};

let usage = Usage::new(
    TokenUsage::new(1500, 200)
        .with_cached_input_tokens(1000)
        .with_cache_write_input_tokens(1200),
);

let tokens = usage.tokens.as_ref().unwrap();
assert_eq!(tokens.input_tokens, 1500);

Fields

tokens: Option<TokenUsage>

Token counts for this turn, if the provider reports them.

cost: Option<CostUsage>

Monetary cost for this turn, if the provider reports it.

metadata: BTreeMap<String, Value>

Arbitrary key-value metadata.

Implementations

impl Usage

pub fn new(tokens: TokenUsage) -> Usage

Builds a usage record with token counts and no cost.

pub fn with_cost(self, cost: CostUsage) -> Usage

Sets the cost information.

pub fn with_metadata(self, metadata: BTreeMap<String, Value>) -> Usage

Replaces the usage metadata.

Trait Implementations

impl Clone for Usage

fn clone(&self) -> Usage

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<(), Error>

Formats the value using the given formatter.

impl Default for Usage

fn default() -> Usage

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Usage

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

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 Usage