Struct RateLimitHeaders 

pub struct RateLimitHeaders {
    pub limit: u64,
    pub remaining: u64,
    pub reset: i64,
    pub retry_after: Option<u64>,
}

Rate limit response headers

Generates standard rate limit response headers, suitable for HTTP API responses.

Standard headers

• X-RateLimit-Limit: maximum number of requests within the window
• X-RateLimit-Remaining: remaining number of requests
• X-RateLimit-Reset: window reset time (Unix seconds)
• Retry-After: suggested retry wait time (seconds) when rejected; included only on rejection

Fields

limit: u64

Maximum number of requests within the window

remaining: u64

Remaining number of requests

reset: i64

Window reset time (Unix seconds)

retry_after: Option<u64>

Retry wait time (seconds); set only when rejected

Implementations

impl RateLimitHeaders

pub fn from_result(result: &RateLimitResult, limit: u64) -> RateLimitHeaders

Creates response headers from a rate limit result

• result: rate limit result
• limit: maximum number of requests within the window

pub fn to_headers(&self) -> Vec<(String, String)>

Converts to HTTP header key-value pairs

pub fn to_json(&self) -> Value

Converts to a JSON object

Trait Implementations

impl Clone for RateLimitHeaders

fn clone(&self) -> RateLimitHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitHeaders

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

Formats the value using the given formatter.