Struct LeakyBucketRateLimiter 

pub struct LeakyBucketRateLimiter {
    pub refill: usize,
    pub interval: Duration,
    pub max: usize,
    pub balance: usize,
    /* private fields */
}

A basic leaky-bucket rate limiter. This is a synchronous implementation with no interior locking since it’s only used by the RateLimitedRouter uniquely and doesn’t share its state

Fields

refill: usize

Tokens to add every per duration.

interval: Duration

Interval in milliseconds to add tokens.

max: usize

Max number of tokens associated with the rate limiter.

balance: usize

The “balance” of the rate limiter, i.e. the number of tokens still available

Implementations

impl LeakyBucketRateLimiter

pub fn builder() -> LeakyBucketRateLimiterBuilder

Create a new LeakyBucketRateLimiter instance

• refill - Tokens to add every per duration.
• interval - Interval to add tokens.
• max - The maximum number of tokens associated with the rate limiter. Default = MAX_LB_BALANCE
• initial - The initial starting balance. If None will be = to max

Returns a new LeakyBucketRateLimiter instance

Trait Implementations

impl Debug for LeakyBucketRateLimiter

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

Formats the value using the given formatter.

impl RateLimiter for LeakyBucketRateLimiter

fn check(&mut self) -> bool

Check if we have not violated the rate limiter

fn bump(&mut self)

Bump the rate limit internal counter, as we’ve routed a message to a worker