Struct TokenBucketConfig 

pub struct TokenBucketConfig {
    pub size: u64,
    pub refill_time_ms: u64,
    pub one_time_burst: u64,
}

One token bucket of a RateLimiterConfig.

The bucket starts full and refills continuously at size tokens per refill_time_ms. one_time_burst grants extra startup tokens that are spent before the regular budget and never refill.

Fields

size: u64

Bucket capacity in tokens. Must be greater than zero.

refill_time_ms: u64

Time to refill size tokens, in milliseconds. Must be greater than zero.

one_time_burst: u64

Extra tokens granted once at startup. Default: 0.

Implementations

impl TokenBucketConfig

pub fn validate(&self, bucket: &'static str) -> Result<(), RateLimitConfigError>

Validate this bucket. bucket names it in error messages.

Trait Implementations

impl Clone for TokenBucketConfig

fn clone(&self) -> TokenBucketConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenBucketConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenBucketConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TokenBucketConfig

impl PartialEq for TokenBucketConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TokenBucketConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TokenBucketConfig