Struct TokenUsage 

pub struct TokenUsage {
    pub provider: Option<String>,
    pub model: Option<String>,
    pub input_tokens: Option<u64>,
    pub output_tokens: Option<u64>,
    pub total_tokens: Option<u64>,
    pub reasoning_tokens: Option<u64>,
    pub cached_input_tokens: Option<u64>,
}

A numeric-only token usage summary for one (provider, model) pair.

Deliberately carries nothing identifying or content-bearing — no prompts, completions, message text, or thread/run/user ids. Only provider and model labels plus counts, so usage can be logged and aggregated in places where conversation content must not go.

Every count is optional and every count is a non-negative integer: None means the provider did not report it, which is distinct from zero.

Fields

provider: Option<String>

The inference provider, for example "anthropic".

model: Option<String>

The model id, for example "claude-opus-5".

input_tokens: Option<u64>

Tokens consumed by the prompt.

output_tokens: Option<u64>

Tokens produced by the model.

total_tokens: Option<u64>

Total tokens, as reported by the provider (not necessarily the sum of the other fields).

reasoning_tokens: Option<u64>

Output tokens spent on reasoning.

cached_input_tokens: Option<u64>

Input tokens served from the provider’s prompt cache.

Implementations

impl TokenUsage

pub fn new() -> Self

An empty usage entry.

pub const fn has_counts(&self) -> bool

Whether any count is present. A labels-only entry reports nothing and should be omitted rather than emitted.

Trait Implementations

impl Clone for TokenUsage

fn clone(&self) -> TokenUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for TokenUsage

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for TokenUsage

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

Formats the value using the given formatter.

impl Default for TokenUsage

fn default() -> TokenUsage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenUsage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TokenUsage

impl JsonSchema for TokenUsage

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 TokenUsage

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

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 TokenUsage

impl ToSchema for TokenUsage

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.