Struct RateLimitInfo 

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

Structured rate-limit metadata matching X-RateLimit-* headers.

Field	HTTP header	Meaning
limit	X-RateLimit-Limit	Max requests allowed in the window
remaining	X-RateLimit-Remaining	Requests still available
reset	X-RateLimit-Reset	Unix timestamp when the window resets
retry_after	Retry-After	Seconds to wait before retrying (429)

Fields

limit: u64

Maximum number of requests allowed in the current window.

remaining: u64

Number of requests remaining in the current window.

reset: u64

Unix timestamp (seconds) at which the current window resets.

retry_after: Option<u64>

Seconds the client should wait before retrying (present on 429 responses).

Implementations

impl RateLimitInfo

pub fn new(limit: u64, remaining: u64, reset: u64) -> Self

Create a new RateLimitInfo.

Examples

use api_bones::ratelimit::RateLimitInfo;

let info = RateLimitInfo::new(100, 50, 1_700_000_000);
assert_eq!(info.limit, 100);
assert_eq!(info.remaining, 50);
assert!(info.retry_after.is_none());

pub fn retry_after(self, seconds: u64) -> Self

Set the retry_after hint (builder-style).

Examples

use api_bones::ratelimit::RateLimitInfo;

let info = RateLimitInfo::new(100, 0, 1_700_000_000).retry_after(60);
assert_eq!(info.retry_after, Some(60));

pub fn is_exceeded(&self) -> bool

Return true when no requests remain in the current window.

Examples

use api_bones::ratelimit::RateLimitInfo;

let exceeded = RateLimitInfo::new(100, 0, 1_700_000_000);
assert!(exceeded.is_exceeded());

let available = RateLimitInfo::new(100, 50, 1_700_000_000);
assert!(!available.is_exceeded());

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<'de> Deserialize<'de> for RateLimitInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RateLimitInfo

impl StructuralPartialEq for RateLimitInfo