redis-cell-rs 0.2.0

Rust bindings for the Redis Cell module
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

# redis-cell-rs

## Description

This crate provides Rust bindings for the [Redis Cell](https://github.com/brandur/redis-cell)
module.

You can define a rate-limiting `Policy` in quite a few ways:

```rust
use redis_cell_rs::Policy;
use std::time::Duration;

const POLICY1: Policy = Policy::from_tokens_per_second(1);

const POLICY2: Policy = Policy::from_tokens_per_minute(100);

const POLICY3: Policy = Policy::from_tokens_per_hour(1_000);

const POLICY4: Policy = Policy::from_tokens_per_day(5_000);

const POLICY5: Policy = Policy::from_tokens_per_period(100, Duration::from_secs(100))
 .max_burst(100)
 .apply_tokens(2)
 .name("general_policy");

const POLICY6: Policy = Policy::new(
 /* burst */  10,
 /* tokens */ 100,
 /* period */ Duration::from_secs(100),
 /* apply */  1
);
```

A policy can now be used to crate rate-limiting request (command), which - in
its turn - can be turned into a Redis command and sent over to the server using
a Redis client. The response can then be converted into `Verdict`.

```rust
use redis_cell_rs::Policy;
use redis::{Cmd as RedisCmd, Client};
use redis_cell_rs::{Cmd, Verdict, AllowedDetails, BlockedDetails};

const POLICY1: Policy = Policy::from_tokens_per_second(1);

let cmd: RedisCmd = Cmd::new("user123", &POLICY1).into();

let client = Client::open("redis://127.0.0.1/").unwrap();
let mut con = client.get_connection().unwrap();

let verdict: Verdict = cmd.query(&mut con).unwrap();
match verdict {
 Verdict::Allowed(details) => {
     let AllowedDetails {total, remaining, reset_after, .. } = details;
     println!("total={}, remaining={}, reset_after={}", total, remaining, reset_after);
 },
 Verdict::Blocked(details) => {
     let BlockedDetails {total, remaining, reset_after, retry_after, .. } = details;
     println!(
         "total={}, remaining={}, reset_after={}, retry_after={}",
         total,
         remaining,
         reset_after,
         retry_after,
     );
 }
}
```

## Development & Contributing

Please find utility commands in [`Makefile`](./Makefile).