Reference
API Reference Guide
A map of the main Trypema types and where to go deeper in the crate docs.
This page is an API map, not a replacement for the crate docs.
Start with these types
| Type | Role |
|---|---|
RateLimiter | top-level entry point |
RateLimiterBuilder | ergonomic setup path |
RateLimiterOptions | explicit configuration path |
RateLimit | per-second limit value |
RateLimitDecision | admission result |
RedisKey | validated key type for Redis and hybrid |
Provider entry points
rl.local()rl.redis()rl.hybrid()
Each provider exposes:
.absolute().suppressed()
Core operations
inc(...)records traffic and returns a decision- local absolute
is_allowed(...)checks without recording - suppressed
get_suppression_factor(...)exposes current pressure
Best place for full API details
Use the generated crate documentation for method-level details, constructor options, and trait impls:
Use this docs site when you want provider/strategy guidance, tuning advice, and performance interpretation.