Lakelezz/eternity

A Rate Limiter With Caching Power!

Eternity

Eternity is a Rust library to rate limit and optionally cache keyed results.

Two use cases:

• You interact with a REST-API lacking official rate limits and you want to cache frequent requests.
• You have a bot with commands and you want to ratelimit them per user or even globally.

View the examples on how to use this library for these cases.

Example

A basic limiter for endpoints:

use eternity::multi_bucket::{CachedLimitedEnums, ToBucket};

#[derive(Hash, PartialEq, Clone, Eq)]
enum Route {
    GetUser(u64),
    GetStats,
    GetGuild(u64),
}

#[tokio::main]
async fn main() {
    let mut limiter: CachedLimitedEnums<Route, String> = CachedLimitedEnums::new();
    limiter.build_group(&Route::GetUser(0)).limit(4).time_span(10).build();
    limiter.build_group(&Route::GetStats).limit(10).time_span(60).build();
    limiter.build_group(&Route::GetGuild(0)).limit(1).time_span(60).build();

    let result = limiter.cache_or(&Route::GetUser(1), get_user(1));
}

async fn get_user(user_id: u64) -> Option<String> {
    Some(format!("eternity-{}", user_id))
}

All Examples

Here are examples to see what this library can be used for.

Features

There are two features and they are not enabled by default.

• cache: Enables functionality to cache values.
• tokio_0_2: By default this crate supports tokio v1, this feature enables v0.2 support.

Installation

Add the following to your Cargo.toml file:

[dependencies]
eternity = "0.1"

Eternity supports a minimum of Rust 1.48.