Struct HeaderProfile 

pub struct HeaderProfile { /* private fields */ }

Available on crate feature provider-headers only.

One provider’s header convention.

Use a built-in profile (HeaderProfile::OPENAI and friends) and call parse.

Implementations

impl HeaderProfile

pub const OPENAI: Self

OpenAI: x-ratelimit-{limit,remaining,reset}-{requests,tokens}, reset as a duration string, plus retry-after.

pub const ANTHROPIC: Self

Anthropic: anthropic-ratelimit-{requests,tokens}-{limit,remaining,reset}, reset as an RFC 3339 instant, plus retry-after.

pub const GITHUB: Self

GitHub: x-ratelimit-{limit,remaining,reset}, reset as an absolute Unix timestamp, plus retry-after.

pub const RFC: Self

The IETF RateLimit header draft: RateLimit-{Limit,Remaining,Reset}, reset as delta-seconds, plus Retry-After. A reasonable default for standards-compliant or unknown APIs.

pub const STRIPE: Self

Stripe: no standard rate-limit headers; it signals back-off with Retry-After on a 429.

pub const AWS: Self

AWS: like Stripe, back-off is signalled with Retry-After.

pub fn parse(&self, headers: &[(&str, &str)]) -> RateLimitInfo

Parses headers into a RateLimitInfo, using the system clock to resolve absolute reset timestamps.

headers is a slice of (name, value) pairs; lookups are case-insensitive.

Examples

use throttle_net::provider::HeaderProfile;

let headers = [
    ("x-ratelimit-limit-requests", "100"),
    ("x-ratelimit-remaining-requests", "42"),
    ("x-ratelimit-reset-requests", "1s"),
];
let info = HeaderProfile::OPENAI.parse(&headers);
let requests = info.requests.unwrap();
assert_eq!(requests.limit, Some(100));
assert_eq!(requests.remaining, Some(42));

pub fn parse_at( &self, headers: &[(&str, &str)], now_unix_secs: i64, ) -> RateLimitInfo

Parses headers relative to an explicit current time (Unix seconds), for deterministic tests and absolute-timestamp providers.

Trait Implementations

impl Clone for HeaderProfile

fn clone(&self) -> HeaderProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HeaderProfile

impl Debug for HeaderProfile

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

Formats the value using the given formatter.