Struct leaky_bucket::Builder

pub struct Builder { /* private fields */ }

A builder for a RateLimiter.

Implementations

impl Builder

pub fn max(&mut self, max: usize) -> &mut Self

Configure the max number of tokens to use.

If unspecified, this will default to be 10 times the refill or the initial value, whichever is largest.

The maximum supported balance is limited to isize::MAX.

Examples

use leaky_bucket::RateLimiter;

let limiter = RateLimiter::builder()
    .max(10_000)
    .build();

pub fn initial(&mut self, initial: usize) -> &mut Self

Configure the initial number of tokens to configure. The default value is 0.

Examples

use leaky_bucket::RateLimiter;

let limiter = RateLimiter::builder()
    .initial(10)
    .build();

pub fn interval(&mut self, interval: Duration) -> &mut Self

Configure the time duration between which we add refill number to the bucket rate limiter.

This is 100ms by default.

Panics

This panics if the provided interval does not fit within the millisecond bounds of a usize or is zero.

use leaky_bucket::RateLimiter;
use tokio::time::Duration;

let limiter = RateLimiter::builder()
    .interval(Duration::from_secs(u64::MAX))
    .build();

use leaky_bucket::RateLimiter;
use tokio::time::Duration;

let limiter = RateLimiter::builder()
    .interval(Duration::from_millis(0))
    .build();

Examples

use leaky_bucket::RateLimiter;
use tokio::time::Duration;

let limiter = RateLimiter::builder()
    .interval(Duration::from_millis(100))
    .build();

pub fn refill(&mut self, refill: usize) -> &mut Self

The number of tokens to add at each interval interval. The default value is 1.

Panics

Panics if a refill amount of 0 is specified.

Examples

use leaky_bucket::RateLimiter;

let limiter = RateLimiter::builder()
    .refill(100)
    .build();

pub fn fair(&mut self, fair: bool) -> &mut Self

Configure the rate limiter to be fair.

Fairness is enabled by deafult.

Fairness ensures that tasks make progress in the order that they acquire even when the rate limiter is under contention. An unfair scheduler might have a higher total throughput.

Fair scheduling also affects the behavior of RateLimiter::try_acquire which will return false if there are any pending tasks since they should be given priority.

Examples

use leaky_bucket::RateLimiter;

let limiter = RateLimiter::builder()
    .refill(100)
    .fair(false)
    .build();

pub fn build(&self) -> RateLimiter

Construct a new RateLimiter.

Examples

use leaky_bucket::RateLimiter;
use tokio::time::Duration;

let limiter = RateLimiter::builder()
    .refill(100)
    .interval(Duration::from_millis(200))
    .max(10_000)
    .build();

Trait Implementations

impl Default for Builder

Construct a new builder with default options.

Examples

use leaky_bucket::Builder;

let limiter = Builder::default().build();

fn default() -> Self

Returns the “default value” for a type.