Struct RateLimiterBuilder 

pub struct RateLimiterBuilder { /* private fields */ }

Builder for creating RateLimiter instances with a declarative API

Implementations

impl RateLimiterBuilder

pub fn new() -> Self

Create a new builder

pub fn limit(self, limit: u64) -> Self

Set the request limit

Example

use rateflow::RateLimiter;

let limiter = RateLimiter::builder()
    .limit(100)
    .build()
    .unwrap();

pub fn window(self, window: Window) -> Self

Set the time window

Example

use rateflow::{RateLimiter, Window};

let limiter = RateLimiter::builder()
    .limit(100)
    .window(Window::Hour)
    .build()
    .unwrap();

pub fn strategy(self, strategy: Strategy) -> Self

Set the rate limiting strategy

Example

use rateflow::{RateLimiter, Strategy};

let limiter = RateLimiter::builder()
    .limit(100)
    .strategy(Strategy::TokenBucket)
    .build()
    .unwrap();

pub fn add_tier(self, tier: Tier) -> Self

Add a tier for multi-tier rate limiting

Example

use rateflow::{RateLimiter, Tier, Window};

let limiter = RateLimiter::builder()
    .add_tier(
        Tier::new("free")
            .limit(100)
            .window(Window::Minute)
    )
    .add_tier(
        Tier::new("premium")
            .limit(1000)
            .window(Window::Minute)
    )
    .build()
    .unwrap();

pub fn build(self) -> Result<RateLimiter>

Build the RateLimiter

Returns an error if the configuration is invalid

Trait Implementations

impl Debug for RateLimiterBuilder

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

Formats the value using the given formatter.

impl Default for RateLimiterBuilder

fn default() -> RateLimiterBuilder

Returns the “default value” for a type.