Struct UsageDimensions 

#[non_exhaustive]
pub struct UsageDimensions {
    pub input_tokens: u64,
    pub output_tokens: u64,
    pub wall_ms: Option<u64>,
    pub custom: BTreeMap<String, u64>,
    pub dedup_key: Option<String>,
}

Usage report for report_usage. Mirrors today’s ff_report_usage_and_check ARGV: token-counts, wall-time, custom dimensions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

input_tokens: u64

Input tokens consumed (LLM-shaped usage). 0 if not applicable.

output_tokens: u64

Output tokens produced (LLM-shaped usage).

wall_ms: Option<u64>

Wall-clock duration, in milliseconds, attributable to this report. None for pure token-count reports.

custom: BTreeMap<String, u64>

Arbitrary caller-defined dimensions. Use BTreeMap for stable iteration order (important for dedup-key derivation on some budget schemes).

dedup_key: Option<String>

Optional caller-supplied idempotency key. When set, the backend rejects a repeat application of the same key with ReportUsageResult::AlreadyApplied rather than double-counting (RFC-012 §R7.4; Lua ff_report_usage_and_check threads this as the trailing ARGV). None / empty string disables dedup.

Implementations

impl UsageDimensions

pub fn new() -> Self

Create an empty usage report (all dimensions zero / None).

Provided for external-crate consumers: UsageDimensions is #[non_exhaustive], so struct-literal and functional-update construction are unavailable across crate boundaries. Start from new() and chain with_* setters to build a report.

pub fn with_input_tokens(self, tokens: u64) -> Self

Set the input-token count dimension. Consumes and returns self for chaining.

pub fn with_output_tokens(self, tokens: u64) -> Self

Set the output-token count dimension. Consumes and returns self for chaining.

pub fn with_wall_ms(self, ms: u64) -> Self

Set the wall-clock duration dimension, in milliseconds. Consumes and returns self for chaining.

pub fn with_dedup_key(self, key: impl Into<String>) -> Self

Set the optional caller-supplied idempotency key. When set, the backend rejects a repeat application of the same key with ReportUsageResult::AlreadyApplied rather than double-counting (RFC-012 §R7.4). Consumes and returns self for chaining.

Trait Implementations

impl Clone for UsageDimensions

fn clone(&self) -> UsageDimensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageDimensions

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

Formats the value using the given formatter.

impl Default for UsageDimensions

fn default() -> UsageDimensions

Returns the “default value” for a type.

impl PartialEq for UsageDimensions

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

impl StructuralPartialEq for UsageDimensions