Struct RateLimitPolicy

pub struct RateLimitPolicy {
    pub count: usize,
    pub per: Duration,
}

A policy for rate-limiting an API key.

Fields

count: usize

The number of times an API key can be used in the specified duration.

per: Duration

The duration.

Implementations

impl RateLimitPolicy

pub fn new(count: usize, per: Duration) -> Self

Returns a rate-limit policy with the parameters.

Arguments

• count - N times
• per - per D duration

Examples found in repository

examples/api-key-pool.rs (line 11)

async fn main() {
    // Create a RateLimitPolicy to be applied to all API keys.
    // Note: An APIPool can have APIKeys with different RateLimitPolicies.
    //       For the sake of simplicity, this example assumes identical policies.
    let pol = RateLimitPolicy::new(1, Duration::seconds(2));

    // Create the APIKeys.
    let api1 = APIKey::new("1", pol);
    let api2 = APIKey::new("2", pol);
    let api3 = APIKey::new("3", pol);

    // Create the APIKeyPool.
    let mut pool = APIKeyPool::new();
    pool.add_key(api1).await;
    pool.add_key(api2).await;
    pool.add_key(api3).await;

    // Simulate 20 requests.
    let mut ctr = 0;
    while ctr < 20 {
        // Use the APIKey if available (according to its respective RateLimitPolicy) or sleep.
        if let Some(key) = pool.poll_for_key().await {
            println!("{}", key);
            ctr += 1;
        } else {
            println!("Have to sleep.");
            time::sleep(time::Duration::from_millis(500)).await;
        }
    }
}

Trait Implementations

impl Clone for RateLimitPolicy

fn clone(&self) -> RateLimitPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateLimitPolicy