Struct RateLimitConfig 

pub struct RateLimitConfig {
    pub capacity: NonZero<u32>,
    pub refill_per_minute: NonZero<u32>,
}

Configuration for a TokenBucket.

Both fields are NonZeroU32, so a zero or otherwise invalid configuration cannot be constructed; there is no separate runtime validation.

Fields

capacity: NonZero<u32>

Maximum burst: how many requests may go out back-to-back before pacing kicks in.

refill_per_minute: NonZero<u32>

Sustained rate: how many requests are earned back per minute.

Implementations

impl RateLimitConfig

pub fn new( capacity: NonZero<u32>, refill_per_minute: NonZero<u32>, ) -> RateLimitConfig

Create a new configuration.

pub fn try_new(capacity: u32, refill_per_minute: u32) -> Option<RateLimitConfig>

Create a configuration from plain integers, returning None if either is zero. A convenience over building the NonZeroU32s by hand.

Trait Implementations

impl Clone for RateLimitConfig

fn clone(&self) -> RateLimitConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateLimitConfig

impl Debug for RateLimitConfig

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

Formats the value using the given formatter.

impl Default for RateLimitConfig

fn default() -> RateLimitConfig

Returns the “default value” for a type.

impl Eq for RateLimitConfig

impl PartialEq for RateLimitConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RateLimitConfig