Struct Usage 

pub struct Usage {
    pub input_tokens: u64,
    pub cached_input_tokens: u64,
    pub cache_write_tokens: u64,
    pub output_tokens: u64,
}

Token counts of one call, normalised across providers.

input_tokens is every prompt token, including the ones served from or written to the cache; cached_input_tokens and cache_write_tokens say how many of them get the cache prices instead of the normal input price.

Fields

input_tokens: u64

All prompt tokens, cached or not.

cached_input_tokens: u64

Prompt tokens read from the provider’s cache (part of input_tokens).

cache_write_tokens: u64

Prompt tokens written to the provider’s cache (part of input_tokens).

output_tokens: u64

Completion tokens, including any reasoning or “thinking” tokens.

Implementations

impl Usage

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

Plain counts with no caching.

pub fn fresh_input_tokens(&self) -> u64

Prompt tokens billed at the normal input price.

pub fn from_json(text: &str) -> Result<Self, BudgetError>

Parse a provider response body, or just its usage object, from JSON text.

Errors

BudgetError::InvalidConfig if the text is not JSON or has no recognisable usage block.

pub fn from_value(v: &Value) -> Result<Self, BudgetError>

Same as from_json for an already parsed value.

Errors

BudgetError::InvalidConfig if there is no recognisable usage block.

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 Copy for Usage

impl Debug for Usage

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

Formats the value using the given formatter.

impl Default for Usage

fn default() -> Self

Returns the “default value” for a type.

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 From<&CompletionUsage> for Usage

Available on crate feature async-openai only.

fn from(u: &CompletionUsage) -> Self

Converts to this type from the input type.

impl JsonSchema for Usage

Available on crate feature schemars only.

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