Struct RateWindow 

pub struct RateWindow {
    pub used_percent: f64,
    pub raw_used_percent: Option<f64>,
    pub resets_at: Option<String>,
    pub window_minutes: Option<i64>,
    pub used_count: Option<f64>,
    pub total_count: Option<f64>,
    pub regeneration: Option<Regeneration>,
}

One rate-limit window: how much of a quota pool is spent and when it resets.

Fields

used_percent: f64

0..100 percent of the window’s quota consumed. This is the EFFECTIVE number consumers pace on: when banked-reset relaxation applies it is zeroed, and the provider-reported percent moves to raw_used_percent.

raw_used_percent: Option<f64>

The provider-reported percent when used_percent has been relaxed to an effective value (banked resets guarantee the window resets before the wall).

Pace on used_percent, not on this. The effective number is the real headroom: a reset that is going to happen has already been accounted for. Treating this as the truer figure routes work away from an account whose credit is about to be spent — and the credit expires whether or not it is used, so the cautious-looking reading is the lossy one. Display it beside the effective number in a human-facing view, where a zero next to real consumption would otherwise look like a fault.

Emitted only where the two diverge, so its absence means they agree and falling back to used_percent is exact rather than approximate. Rendering a placeholder for absence would be wrong on every unrelaxed window, which is nearly all of them.

resets_at: Option<String>

ISO 8601 / RFC 3339 timestamp when the window resets. Omitted when the provider reports no reset (e.g. an idle session window with nothing pending) — never fabricated.

window_minutes: Option<i64>

Window length in minutes. Omitted when the provider does not report one; the consumer then paces on utilization alone rather than a burn rate.

used_count: Option<f64>

Absolute consumed count in the window (e.g. tokens, requests). A count of things, so integral by contract, and only ever the upstream’s own figure — never recovered from a percentage and a cap (a derived figure can carry a disagreement between two provider endpoints while wearing a type that claims exactness). Omitted when the upstream reports only a percentage. Human-facing UIs can show “10,336 / 40,000” alongside the percentage for richer context.

total_count: Option<f64>

Absolute total cap for the window, when the upstream states one. May appear without used_count: the cap can be known while the consumed figure is only a percentage.

regeneration: Option<Regeneration>

How the window’s quota comes back, when the upstream STATES a mechanic.

Absence licenses nothing. It means the upstream said nothing about replenishment — never “this is a fixed window”. Most providers state nothing, so absence is the common case and carries no information.

Trait Implementations

impl Clone for RateWindow

fn clone(&self) -> RateWindow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateWindow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateWindow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RateWindow

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RateWindow

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 RateWindow