Struct TokenBucket

pub struct TokenBucket { /* private fields */ }

TokenBucket provides a lower level interface to rate limiting with a configurable capacity, refill-rate and initial burst.

Implementations

impl TokenBucket

pub fn new(size: u64, one_time_burst: u64, complete_refill_time_ms: u64) -> Self

Creates a TokenBucket wrapped in an Option.

TokenBucket created is of size total capacity and takes complete_refill_time_ms milliseconds to go from zero tokens to total capacity. The one_time_burst is initial extra credit on top of total capacity, that does not replenish and which can be used for an initial burst of data.

If the size or the complete refill time are zero, then None is returned.

pub fn reduce(&mut self, tokens: u64) -> BucketReduction

Attempts to consume tokens from the bucket and returns whether the action succeeded.

pub fn force_replenish(&mut self, tokens: u64)

“Manually” adds tokens to bucket.

pub fn capacity(&self) -> u64

Returns the capacity of the token bucket.

pub fn one_time_burst(&self) -> u64

Returns the remaining one time burst budget.

pub fn refill_time_ms(&self) -> u64

Returns the time in milliseconds required to to completely fill the bucket.

pub fn budget(&self) -> u64

Returns the current budget (one time burst allowance notwithstanding).

pub fn initial_one_time_burst(&self) -> u64

Returns the initially configured one time burst budget.

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> TokenBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenBucket

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

Formats the value using the given formatter.

impl PartialEq for TokenBucket

fn eq(&self, other: &TokenBucket) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TokenBucket

impl StructuralPartialEq for TokenBucket