Struct RateLimitInfo 

pub struct RateLimitInfo {
    pub requests: Option<Window>,
    pub tokens: Option<Window>,
    pub retry_after: Option<Duration>,
}

Available on crate feature provider-headers only.

A normalized view of the rate-limit headers on a response.

Providers that meter requests and tokens separately (the LLM APIs) populate both requests and tokens; single-limit providers populate only requests. retry_after carries a Retry-After when present.

Fields

requests: Option<Window>

The request-count window, if the response carried one.

tokens: Option<Window>

The token window, if the response carried one (LLM providers).

retry_after: Option<Duration>

The Retry-After delay, if present.

Implementations

impl RateLimitInfo

pub fn sync_requests<C: Clock + Clone>(&self, throttle: &Throttle<C>) -> u32

Reconciles throttle with the server’s reported requests-remaining, draining tokens so the local available count does not exceed it.

This only ever reduces the local budget — it never adds tokens — so it corrects client/server drift without ever raising the throttle above its hard capacity. Returns the number of tokens drained.

Examples

use throttle_net::Throttle;
use throttle_net::provider::{RateLimitInfo, Window};

let throttle = Throttle::per_second(100); // locally believes 100 are free
let info = RateLimitInfo {
    requests: Some(Window { remaining: Some(10), ..Window::default() }),
    ..RateLimitInfo::default()
};
let drained = info.sync_requests(&throttle);
assert_eq!(drained, 90);
assert_eq!(throttle.available(), 10); // now matches the server

pub fn sync_tokens<C: Clock + Clone>(&self, throttle: &Throttle<C>) -> u32

Reconciles throttle with the server’s reported tokens-remaining, the same way as sync_requests. Returns the tokens drained.

Trait Implementations

impl Clone for RateLimitInfo

fn clone(&self) -> RateLimitInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateLimitInfo

impl Debug for RateLimitInfo

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

Formats the value using the given formatter.

impl Default for RateLimitInfo

fn default() -> RateLimitInfo

Returns the “default value” for a type.

impl Eq for RateLimitInfo

impl PartialEq for RateLimitInfo

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