Struct ratelimit::Ratelimiter

pub struct Ratelimiter { /* private fields */ }

Implementations

impl Ratelimiter

pub fn builder(amount: u64, interval: Duration) -> Builder

Initialize a builder that will construct a Ratelimiter that adds the specified amount of tokens to the token bucket after each interval has elapsed.

Note: In practice, the system clock resolution imposes a lower bound on the interval. To be safe, it is recommended to set the interval to be no less than 1 microsecond. This also means that the number of tokens per interval should be > 1 to achieve rates beyond 1 million tokens/s.

pub fn rate(&self) -> f64

Return the current effective rate of the Ratelimiter in tokens/second

pub fn refill_interval(&self) -> Duration

Return the current interval between refills.

pub fn set_refill_interval(&self, duration: Duration) -> Result<(), Error>

Allows for changing the interval between refills at runtime.

pub fn refill_amount(&self) -> u64

Return the current number of tokens to be added on each refill.

pub fn set_refill_amount(&self, amount: u64) -> Result<(), Error>

Allows for changing the number of tokens to be added on each refill.

pub fn max_tokens(&self) -> u64

Returns the maximum number of tokens that can

pub fn set_max_tokens(&self, amount: u64) -> Result<(), Error>

Allows for changing the maximum number of tokens that can be held by the ratelimiter for immediate use. This effectively sets the burst size. The configured value must be greater than or equal to the refill amount.

pub fn available(&self) -> u64

Returns the number of tokens currently available.

pub fn set_available(&self, amount: u64) -> Result<(), Error>

Sets the number of tokens available to some amount. Returns an error if the amount exceeds the bucket capacity.

pub fn dropped(&self) -> u64

Returns the number of tokens that have been dropped due to bucket overflowing.

pub fn try_wait(&self) -> Result<(), Duration>

Non-blocking function to “wait” for a single token. On success, a single token has been acquired. On failure, a Duration hinting at when the next refill would occur is returned.