Struct RateLimit 

pub struct RateLimit { /* private fields */ }

Rate limit information from GitHub API response headers.

GitHub includes rate limit information in HTTP response headers:

• X-RateLimit-Limit: Maximum requests allowed per hour
• X-RateLimit-Remaining: Requests remaining in current window
• X-RateLimit-Reset: Unix timestamp when the rate limit resets

Examples

use github_bot_sdk::client::RateLimit;
use chrono::{Utc, Duration};

let reset_time = Utc::now() + Duration::hours(1);
let rate_limit = RateLimit::new(5000, 4500, reset_time, "core");

assert!(!rate_limit.is_exhausted());
assert!(rate_limit.remaining() > 1000);

Implementations

impl RateLimit

pub fn new( limit: u32, remaining: u32, reset_at: DateTime<Utc>, resource: impl Into<String>, ) -> Self

Create a new rate limit from GitHub API response.

Arguments

• limit - Maximum requests allowed
• remaining - Requests remaining
• reset_at - When the limit resets
• resource - The resource type (default “core”)

pub fn limit(&self) -> u32

Get the maximum number of requests allowed.

pub fn remaining(&self) -> u32

Get the number of requests remaining.

pub fn reset_at(&self) -> DateTime<Utc>

Get when the rate limit resets.

pub fn resource(&self) -> &str

Get the resource this rate limit applies to.

pub fn is_exhausted(&self) -> bool

Check if the rate limit is exhausted (no requests remaining).

pub fn is_near_exhaustion(&self, margin: f64) -> bool

Check if we’re close to exhausting the rate limit.

Arguments

• margin - The safety margin as a fraction (0.0 to 1.0)

Returns true if remaining requests are below the margin threshold.

Examples

let rate_limit = RateLimit::new(5000, 400, Utc::now(), "core");

// Check if we're below 10% remaining
assert!(rate_limit.is_near_exhaustion(0.1));

pub fn has_reset(&self) -> bool

Check if the rate limit has been reset.

Returns true if the current time is past the reset time.

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.