trypema 2.0.0

High-performance rate limiting primitives in Rust, designed for concurrency safety, low overhead, and predictable latency.
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

#![doc = include_str!("../docs/lib.md")]
#![cfg_attr(docsrs, feature(doc_cfg), warn(rustdoc::broken_intra_doc_links))]
#![deny(missing_docs)]
#![forbid(unsafe_code)]

#[cfg(all(feature = "redis-tokio", feature = "redis-smol"))]
compile_error!("Features `redis-tokio` and `redis-smol` are mutually exclusive");

mod builder;
pub use builder::RateLimiterBuilder;

#[cfg(any(feature = "redis-tokio", feature = "redis-smol"))]
pub(crate) mod runtime;

pub mod local;

/// Redis-backed distributed rate limiter implementations.
///
/// Provides [`RedisRateLimiterProvider`](redis::RedisRateLimiterProvider), which executes
/// all operations as atomic Lua scripts against Redis 7.2+. Each `inc()` or `is_allowed()`
/// call results in one Redis round-trip.
#[cfg(any(feature = "redis-tokio", feature = "redis-smol"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "redis-tokio", feature = "redis-smol"))))]
pub mod redis;

/// Hybrid rate limiter implementations (local fast-path + periodic Redis sync).
///
/// Provides [`HybridRateLimiterProvider`](hybrid::HybridRateLimiterProvider), which maintains
/// local in-memory state for low-latency admission checks and periodically flushes accumulated
/// increments to Redis in batches. This reduces Redis round-trips compared to the pure Redis
/// provider, at the cost of some additional approximation due to sync lag.
#[cfg(any(feature = "redis-tokio", feature = "redis-smol"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "redis-tokio", feature = "redis-smol"))))]
pub mod hybrid;

mod error;
pub use error::TrypemaError;

mod common;
pub use common::{
    BucketSize, ConditionalSetOutcome, HardLimitFactor, HistoryPreservation, RateLimit,
    RateLimitComparator, RateLimitDecision, SuppressedRateLimitSnapshot,
    SuppressionFactorCachePeriod, WindowSize,
};

#[cfg(test)]
mod tests;