Struct RateLimiter 

pub struct RateLimiter { /* private fields */ }

Thread-safe rate limit tracker for GitHub API operations.

Tracks rate limits for different GitHub API resources and authentication contexts (app-level vs installation-level) and provides methods to check rate limits before making requests.

Examples

use github_bot_sdk::client::{RateLimiter, RateLimitContext};
use github_bot_sdk::auth::InstallationId;

let rate_limiter = RateLimiter::new(0.1); // 10% safety margin

// Check if we can make an app-level request
if rate_limiter.can_proceed(&RateLimitContext::App, "core") {
    // Make API request
}

// Check if we can make an installation-level request
let install_id = InstallationId::new(12345);
if rate_limiter.can_proceed(&RateLimitContext::Installation(install_id), "core") {
    // Make API request
}

Implementations

impl RateLimiter

pub fn new(margin: f64) -> Self

Create a new rate limiter with the specified safety margin.

Arguments

• margin - Safety margin (0.0 to 1.0) to keep as a buffer

Examples

use github_bot_sdk::client::RateLimiter;

// Keep 10% buffer
let limiter = RateLimiter::new(0.1);

pub fn update_from_headers( &self, context: &RateLimitContext, headers: &HeaderMap, )

Update rate limit information from response headers.

Arguments

• context - The authentication context (app or installation)
• headers - HTTP response headers containing rate limit info

pub fn can_proceed(&self, context: &RateLimitContext, resource: &str) -> bool

Check if we can proceed with a request for the given context and resource.

Arguments

• context - The authentication context (app or installation)
• resource - The resource type (e.g., “core”, “search”)

Returns

true if we have sufficient rate limit remaining (considering safety margin), false if we’re at or near the rate limit.

pub fn get_limit( &self, context: &RateLimitContext, resource: &str, ) -> Option<RateLimit>

Get the current rate limit for a context and resource.

Arguments

• context - The authentication context (app or installation)
• resource - The resource type

Returns

Some(RateLimit) if we have rate limit data for this context/resource, None if we haven’t received rate limit headers yet.

Trait Implementations

impl Clone for RateLimiter

fn clone(&self) -> RateLimiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimiter

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

Formats the value using the given formatter.

impl Default for RateLimiter

fn default() -> Self

Returns the “default value” for a type.