Struct leaky_bucket::LeakyBuckets

pub struct LeakyBuckets { /* fields omitted */ }

Coordinator for rate limiters. Is used to create new rate limiters as needed.

Implementations

impl LeakyBuckets

pub fn new() -> Self

Construct a new coordinator for rate limiters.

pub fn coordinate(
    &mut self
) -> Result<impl Future<Output = Result<(), Error>> + 'static, Error>

Run the coordinator.

Examples

use leaky_bucket::LeakyBuckets;
use std::{error::Error, time::Duration};

let mut buckets = LeakyBuckets::new();
let coordinator = buckets.coordinate()?;

// spawn the coordinate thread to refill the rate limiter.
tokio::spawn(async move { coordinator.await.expect("coordinator errored") });

pub fn rate_limiter(&self) -> Builder<'_>

Construct a new rate limiter.

Trait Implementations

impl Default for LeakyBuckets

fn default() -> Self

Returns the "default value" for a type.