throttlecrab 0.1.0

A high-performance GCRA (Generic Cell Rate Algorithm) rate limiter
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

# throttlecrab

[![CI](https://github.com/lazureykis/throttlecrab/actions/workflows/ci.yml/badge.svg)](https://github.com/lazureykis/throttlecrab/actions/workflows/ci.yml)
[![Coverage Status](https://codecov.io/gh/lazureykis/throttlecrab/branch/master/graph/badge.svg)](https://codecov.io/gh/lazureykis/throttlecrab)
[![Crates.io](https://img.shields.io/crates/v/throttlecrab.svg)](https://crates.io/crates/throttlecrab)
[![Documentation](https://docs.rs/throttlecrab/badge.svg)](https://docs.rs/throttlecrab)
[![License](https://img.shields.io/crates/l/throttlecrab.svg)](LICENSE-MIT)

A high-performance GCRA (Generic Cell Rate Algorithm) rate limiter for Rust.

## Features

- **GCRA-based rate limiting**: Implements the Generic Cell Rate Algorithm for smooth and fair rate limiting
- **High performance**: Optimized for minimal overhead
- **Thread-safe**: Safe to use across multiple threads
- **Async support**: Works seamlessly with async Rust applications
- **Flexible configuration**: Customizable rate limits and burst capacity

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
throttlecrab = "0.1.0"
```

## Usage

```rust
use throttlecrab::RateLimiter;
use std::time::Duration;

fn main() {
    // Create a rate limiter that allows 10 requests per second
    let limiter = RateLimiter::new(10, Duration::from_secs(1));
    
    // Check if a request is allowed
    if limiter.check() {
        println!("Request allowed!");
    } else {
        println!("Rate limit exceeded!");
    }
}
```

## What is GCRA?

The Generic Cell Rate Algorithm (GCRA) is a rate limiting algorithm that provides:
- Smooth traffic shaping
- Burst tolerance
- Fair resource allocation
- Predictable behavior

Unlike token bucket or leaky bucket algorithms, GCRA provides more consistent rate limiting without the "burst then wait" patterns.

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.