rateflow 0.1.0

A declarative, flexible, and high-performance rate limiting library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# RateFlow

A declarative, flexible, and high-performance rate limiting library for Rust.

## Features

- **Declarative API** - Configure complex rate limits with a simple, readable builder pattern
- **Custom Strategies** - Define different rate limits per endpoint, user tier, or client
- **Multiple Algorithms** - Token bucket and sliding window implementations
- **High Performance** - Optimized for low overhead in high-traffic scenarios
- **Flexible Identification** - Rate limit by IP address, API key, user ID, or custom identifiers

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
rateflow = "0.1"
tokio = { version = "1", features = ["full"] }
```

## Quick Start

```rust
use rateflow::{RateLimiter, Window};

// Create a rate limiter with 100 requests per minute
let limiter = RateLimiter::builder()
    .limit(100)
    .window(Window::Minute)
    .build()
    .unwrap();

// Check if a request is allowed
let client_id = "user@example.com";
if limiter.check(client_id).await {
    // Process request
} else {
    // Reject request
}
```

## Multi-Tier Example

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

// Configure different limits for different user tiers
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();

// Check with tier information
if limiter.check_tier("free", "user@example.com").await {
    // Process request
}
```

## License

Apache 2