Struct RateLimitResource 

pub struct RateLimitResource {
    pub used: u64,
    pub limit: u64,
    pub remaining: u64,
    pub percent: f64,
    pub reset: i64,
}

One resource’s budget usage, parsed from a /rate_limit resources.<name> object.

Fields

used: u64

Requests spent in the current window.

limit: u64

The window’s ceiling.

remaining: u64

Requests remaining (limit - used, as GitHub reports it).

percent: f64

used / limit * 100, rounded to one decimal. 0.0 when limit is 0, so a missing or zero ceiling never divides by zero or reads as “over budget”.

reset: i64

Unix epoch (seconds) at which the window resets. Rendered as HH:MMZ by format_reset_utc; kept raw on the wire so machines can compute their own.

Implementations

impl RateLimitResource

pub fn over_warn(&self) -> bool

Whether this resource is at or above the WARN_PERCENT threshold.

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

Builds a resource from parts, computing percent. Used to fold a graphql budget reading carried by a PR poll (#1389, fix 8) into the cache without re-parsing a /rate_limit reply.

Trait Implementations

impl Clone for RateLimitResource

fn clone(&self) -> RateLimitResource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateLimitResource

impl Debug for RateLimitResource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateLimitResource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RateLimitResource

fn eq(&self, other: &RateLimitResource) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RateLimitResource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RateLimitResource