Struct RateLimitConfig 

#[non_exhaustive]
pub struct RateLimitConfig {
    pub max_tokens: f64,
    pub refill_rate: f64,
}

Extensible configuration for the Token-Bucket Rate Limiter.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_tokens: f64

Maximum number of tokens (burst capacity). A request consumes 1 token.

refill_rate: f64

Token refill rate in tokens per second. Use the per_second, per_minute, per_hour factories.

Implementations

impl RateLimitConfig

pub fn new(max_tokens: f64, refill_rate: f64) -> RateLimitConfig

Creates a new RateLimitConfig with explicit burst capacity and refill rate. For convenience, prefer the factory methods: per_second, per_minute, per_hour.

pub fn per_second(limit: f64) -> RateLimitConfig

Creates a limit of N requests per second.

pub fn per_minute(limit: f64) -> RateLimitConfig

Creates a limit of N requests per minute.

pub fn per_hour(limit: f64) -> RateLimitConfig

Creates a limit of N requests per hour.

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 Debug for RateLimitConfig

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

Formats the value using the given formatter.