Struct RateLimitInfo 

pub struct RateLimitInfo {
    pub limit: Option<u64>,
    pub remaining: Option<u64>,
    pub reset_secs: Option<u64>,
    pub cost: Option<u64>,
}

Rate limit information extracted from response headers.

Envoy’s rate limiter returns these headers in the IETF draft format:

• x-ratelimit-limit: e.g. "50, 50;w=60" (total quota for the window)
• x-ratelimit-remaining: e.g. "40" (remaining budget in window)
• x-ratelimit-reset: e.g. "41" (seconds until window resets)
• x-ratelimit-cost: e.g. "10" (budget consumed per request)

Fields

limit: Option<u64>

Total request quota for the current window.

Parsed from x-ratelimit-limit. For IETF draft format like "50, 50;w=60", the first integer before the comma is used.

remaining: Option<u64>

Remaining budget in the current window.

Parsed from x-ratelimit-remaining. Note this is budget units, not request count. Divide by cost to get the number of requests remaining.

reset_secs: Option<u64>

Seconds until the rate limit window resets.

Parsed from x-ratelimit-reset.

cost: Option<u64>

Budget consumed per request.

Parsed from x-ratelimit-cost. For example, if limit is 50 and cost is 10, you can make 5 requests per window.

Implementations

impl RateLimitInfo

pub fn is_rate_limited(&self) -> bool

Returns true if the rate limit quota has been exhausted.

pub fn suggested_wait_secs(&self) -> Option<u64>

Returns the suggested number of seconds to wait before making another request.

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 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 Display for RateLimitInfo

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

Formats the value using the given formatter.