Struct RateLimitSnapshot 

pub struct RateLimitSnapshot {
    pub limit: u64,
    pub remaining: u64,
    pub used: Option<u64>,
    pub reset_unix_secs: u64,
    pub observed_at: Timestamp,
}

What GitHub said about the account’s hourly quota on one response.

Fields

limit: u64

x-ratelimit-limit.

remaining: u64

x-ratelimit-remaining.

used: Option<u64>

x-ratelimit-used, when sent.

reset_unix_secs: u64

x-ratelimit-reset, a Unix timestamp in seconds.

observed_at: Timestamp

When this host read it.

Implementations

impl RateLimitSnapshot

pub fn from_headers(headers: &HeaderMap, now: Timestamp) -> Option<Self>

The core quota’s state from a response’s headers, or None when the response did not carry all three of limit, remaining and reset, or described a different resource (search, graphql, …), whose bucket is not the one demand polling spends.

pub fn reset_in(&self, now: Timestamp) -> Duration

How long until the quota resets, zero once it has.

pub fn pressure(&self, now: Timestamp) -> PrimaryPressure

How hard this reading says to slow down.

A reading whose reset has passed says nothing about the current window, so it is PrimaryPressure::Normal however low it was.

Trait Implementations

impl Clone for RateLimitSnapshot

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateLimitSnapshot

impl Debug for RateLimitSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateLimitSnapshot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RateLimitSnapshot

impl PartialEq for RateLimitSnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RateLimitSnapshot

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 RateLimitSnapshot