Struct RateLimit 

pub struct RateLimit {
    pub limit: u16,
    pub remaining: u16,
    pub reset: Timestamp,
}

Rate limit information: the number of requests that can be made per hour, the remaining request count, and the time at which the limit will be reset.

PVOutput docs

Fields

limit: u16

The total request limit for the hour.

remaining: u16

The remaining requests for the hour.

reset: Timestamp

The time at which the rate limit will be reset.

Implementations

impl RateLimit

pub const fn used(&self) -> u16

The number of requests that have been used in this hourly block.

Example

use pvoutput_client::types::response::RateLimit;
use jiff::Timestamp;
let rate_limit = RateLimit { limit: 300, remaining: 100, reset: Timestamp::now() };
assert_eq!(rate_limit.used(), 200);

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl TryFrom<&HeaderMap> for RateLimit

type Error = RateLimitError

The type returned in the event of a conversion error.

fn try_from(value: &HeaderMap) -> Result<Self, Self::Error>

Performs the conversion.