Skip to main content

Usage

rig_core::completion::request

Struct Usage

pub struct Usage {
    pub input_tokens: u64,
    pub output_tokens: u64,
    pub total_tokens: u64,
    pub cached_input_tokens: u64,
    pub cache_creation_input_tokens: u64,
    pub tool_use_prompt_tokens: u64,
    pub reasoning_tokens: u64,
}

Expand description

Struct representing the token usage for a completion request. If tokens used are 0, then the provider failed to supply token usage metrics.

Fields§

§input_tokens: u64

The number of input (“prompt”) tokens used in a given request.

§output_tokens: u64

The number of output (“completion”) tokens used in a given request.

§total_tokens: u64

We store this separately as some providers may only report one number

§cached_input_tokens: u64

The number of input tokens read from a provider-managed cache

§cache_creation_input_tokens: u64

The number of input tokens written to a provider-managed cache

§tool_use_prompt_tokens: u64

The number of tool-use prompt tokens used in a given request.

§reasoning_tokens: u64

The number of tokens spent on internal reasoning / “thoughts” by reasoning-capable models (e.g. Gemini thinking, Anthropic extended thinking, OpenAI o-series).

Implementations§

impl Usage

pub fn new() -> Self

Creates a new instance of Usage.

pub fn has_values(&self) -> bool

Whether any usage values are set and non-zero.

Zero-valued usage is this type’s documented sentinel for “the provider supplied no usage metrics”, so false means usage was not reported.

Trait Implementations§

impl Add for Usage

type Output = Usage

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation. Read more

impl AddAssign for Usage

fn add_assign(&mut self, other: Self)

Performs the += operation. Read more

impl Clone for Usage

fn clone(&self) -> Usage

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for Usage

impl Debug for Usage

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

Formats the value using the given formatter. Read more

impl Default for Usage

fn default() -> Self

Returns the “default value” for a type. Read more

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. Read more

impl Eq for Usage

impl From<&CompletionResponse> for Usage

fn from(response: &CompletionResponse) -> Usage

Converts to this type from the input type.

impl From<&CopilotStreamingResponse> for Usage

fn from(response: &CopilotStreamingResponse) -> Self

Converts to this type from the input type.

impl From<&Interaction> for Usage

fn from(value: &Interaction) -> Usage

Converts to this type from the input type.

impl From<&InteractionUsage> for Usage

fn from(value: &InteractionUsage) -> Usage

Converts to this type from the input type.

impl From<&PartialUsage> for Usage

fn from(value: &PartialUsage) -> Usage

Converts to this type from the input type.

impl From<&ResponsesUsage> for Usage

fn from(usage: &ResponsesUsage) -> Self

Converts to this type from the input type.

impl From<&StreamingCompletionResponse> for Usage

fn from(response: &StreamingCompletionResponse) -> Usage

Converts to this type from the input type.

impl From<&StreamingCompletionResponse> for Usage

fn from(value: &StreamingCompletionResponse) -> Usage

Converts to this type from the input type.

impl From<&StreamingCompletionResponse> for Usage

fn from(value: &StreamingCompletionResponse) -> Usage

Converts to this type from the input type.

impl From<&StreamingCompletionResponse> for Usage

fn from(response: &StreamingCompletionResponse) -> Usage

Converts to this type from the input type.

impl From<&StreamingCompletionResponse> for Usage

fn from(response: &StreamingCompletionResponse) -> Self

Converts to this type from the input type.

impl From<&Usage> for Usage

fn from(value: &Usage) -> Usage

Converts to this type from the input type.

impl From<&Usage> for Usage

tokens is the total-usage counter; billed_units excludes cached input and system overhead, silently undercounting.

fn from(usage: &Usage) -> Usage

Converts to this type from the input type.

impl From<&Usage> for Usage

fn from(usage: &Usage) -> Self

Converts to this type from the input type.

impl From<&Usage> for Usage

fn from(usage: &Usage) -> Self

Converts to this type from the input type.

impl From<&Usage> for Usage

fn from(usage: &Usage) -> Self

Converts to this type from the input type.

impl From<&Usage> for Usage

fn from(value: &Usage) -> Usage

Converts to this type from the input type.

impl From<&Usage> for Usage

fn from(value: &Usage) -> Usage

Converts to this type from the input type.

impl From<&UsageMetadata> for Usage

fn from(value: &UsageMetadata) -> Usage

Converts to this type from the input type.

impl From<Interaction> for Usage

fn from(value: Interaction) -> Usage

Converts to this type from the input type.

impl From<InteractionUsage> for Usage

fn from(value: InteractionUsage) -> Usage

Converts to this type from the input type.

impl From<PartialUsage> for Usage

fn from(value: PartialUsage) -> Usage

Converts to this type from the input type.

impl From<ResponsesUsage> for Usage

fn from(usage: ResponsesUsage) -> Self

Converts to this type from the input type.

impl From<StreamingCompletionResponse> for Usage

fn from(value: StreamingCompletionResponse) -> Usage

Converts to this type from the input type.

impl From<StreamingCompletionResponse> for Usage

fn from(value: StreamingCompletionResponse) -> Usage

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(value: Usage) -> Usage

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(usage: Usage) -> Usage

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(usage: Usage) -> Self

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(usage: Usage) -> Self

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(usage: Usage) -> Self

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(value: Usage) -> Usage

Converts to this type from the input type.

impl From<Usage> for Usage

fn from(value: Usage) -> Usage

Converts to this type from the input type.

impl From<UsageMetadata> for Usage

fn from(value: UsageMetadata) -> Usage

Converts to this type from the input type.

impl PartialEq for Usage

fn eq(&self, other: &Usage) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

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. Read more

impl StructuralPartialEq for Usage

Auto Trait Implementations§

impl Freeze for Usage

impl RefUnwindSafe for Usage

impl Send for Usage

impl Sync for Usage

impl Unpin for Usage

impl UnsafeUnpin for Usage

impl UnwindSafe for Usage

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoToolOutput for T
where T: Serialize + 'static,

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WasmCompatSend for T
where T: Send,

impl<T> WasmCompatSync for T
where T: Sync,

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more