Trait GetTokenUsage 

pub trait GetTokenUsage {
    // Required method
    fn token_usage(&self) -> Option<Usage>;
}

A trait for grabbing the token usage of a completion response.

Primarily designed for streamed completion responses in streamed multi-turn, as otherwise it would be impossible to do.

Required Methods

fn token_usage(&self) -> Option<Usage>

Returns token usage when the response type carries it.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl GetTokenUsage for ()

fn token_usage(&self) -> Option<Usage>

impl<T> GetTokenUsage for Option<T>

where T: GetTokenUsage,

fn token_usage(&self) -> Option<Usage>

Implementors

impl GetTokenUsage for CompletionResponse

impl GetTokenUsage for CopilotStreamingResponse

impl GetTokenUsage for Interaction

impl GetTokenUsage for InteractionUsage

impl GetTokenUsage for MockResponse

Available on crate feature test-utils only.

impl GetTokenUsage for rig_core::providers::anthropic::streaming::PartialUsage

impl GetTokenUsage for rig_core::providers::gemini::streaming::PartialUsage

impl GetTokenUsage for ResponsesUsage

impl GetTokenUsage for rig_core::providers::anthropic::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::cohere::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::deepseek::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::gemini::interactions_api::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::gemini::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::groq::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::llamafile::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::ollama::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::openai::completion::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::openai::responses_api::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::openrouter::streaming::StreamingCompletionResponse

impl GetTokenUsage for rig_core::providers::anthropic::completion::Usage

impl GetTokenUsage for rig_core::providers::azure::Usage

impl GetTokenUsage for rig_core::providers::cohere::completion::Usage

impl GetTokenUsage for rig_core::providers::deepseek::Usage

impl GetTokenUsage for rig_core::providers::huggingface::completion::Usage

impl GetTokenUsage for rig_core::providers::openai::completion::Usage

impl GetTokenUsage for rig_core::providers::openrouter::client::Usage

impl GetTokenUsage for rig_core::providers::openrouter::streaming::Usage

impl GetTokenUsage for UsageMetadata