Struct leaky_bucket_lite::LeakyBucket

pub struct LeakyBucket { /* fields omitted */ }

The leaky bucket.

Implementations

impl LeakyBucket

pub fn builder() -> Builder

Construct a new leaky bucket through a builder.

pub fn max(&self) -> f64

Get the max number of tokens this rate limiter is configured for.

pub async fn tokens(&self) -> Result<f64, Error>

Get the current number of tokens available.

Errors

Returns an Error when communicating with the actor fails.

pub async fn acquire_one(&self) -> Result<(), Error>

Acquire a single token.

This is identical to acquire with an argument of 1.0.

Example

use leaky_bucket_lite::LeakyBucket;
use std::{error::Error, time::Duration};

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let rate_limiter = LeakyBucket::builder()
        .max(5.0)
        .tokens(0.0)
        .refill_interval(Duration::from_secs(5))
        .refill_amount(1.0)
        .build();

    println!("Waiting for permit...");
    // should take about 5 seconds to acquire.
    rate_limiter.acquire_one().await?;
    println!("I made it!");

    Ok(())
}

Errors

Returns an Error when communicating with the actor fails.

pub async fn acquire(&self, amount: f64) -> Result<(), Error>

Acquire the given amount of tokens.

Example

use leaky_bucket_lite::LeakyBucket;
use std::{error::Error, time::Duration};

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let rate_limiter = LeakyBucket::builder()
        .max(5.0)
        .tokens(0.0)
        .refill_interval(Duration::from_secs(5))
        .refill_amount(1.0)
        .build();

    println!("Waiting for permit...");
    // should take about 25 seconds to acquire.
    rate_limiter.acquire(5.0).await?;
    println!("I made it!");

    Ok(())
}

Errors

Returns an Error when communicating with the actor fails.

Trait Implementations

impl Clone for LeakyBucket

fn clone(&self) -> LeakyBucket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LeakyBucket

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

Formats the value using the given formatter.