gardal 0.0.1-alpha.6

A WIP performance-focused token-bucket rate limiting and throttling library
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

#![doc = include_str!("../README.md")]
//!
//! # Core Components
//!
//! - [`TokenBucket`] - The main token bucket implementation with pluggable storage and clock
//! - [`Limit`] - Configuration for rate and burst limits
//! - [`Clock`] trait and implementations for time sources
//! - Storage implementations for different concurrency needs
//!
//! # Quick Start
//!
//! ```rust
//! use std::num::NonZeroU32;
//!
//! use gardal::{TokenBucket, Limit};
//!
//! // Create a rate limit: 10 tokens per second, burst of 20
//! let limit = Limit::per_second_and_burst(
//!     NonZeroU32::new(10).unwrap(),
//!     NonZeroU32::new(20).unwrap()
//! );
//!
//! // Create token bucket
//! let bucket = TokenBucket::new(limit);
//!
//! // Try to consume tokens
//! if let Some(tokens) = bucket.consume(NonZeroU32::new(5).unwrap()) {
//!     println!("Consumed {} tokens", tokens.as_u64());
//! }
//! ```

mod bucket;
mod clock;
mod error;
#[cfg(feature = "async")]
pub mod futures;
mod limit;
mod storage;
mod tokens;

pub use bucket::{TokenBucket, UNLIMITED_BUCKET};
#[cfg(feature = "tokio")]
pub use clock::TokioClock;
pub use clock::{Clock, ManualClock, StdClock};
#[cfg(feature = "quanta")]
pub use clock::{FastClock, QuantaClock};
pub use error::*;
#[cfg(feature = "async")]
pub use futures::StreamExt;
pub use limit::Limit;
pub use tokens::Tokens;

pub use storage::{
    TimeStorage, atomic::AtomicSharedStorage, atomic::AtomicStorage, local::LocalStorage,
    padded_atomic::PaddedAtomicSharedStorage, padded_atomic::PaddedAtomicStorage,
};

pub(crate) mod private {
    pub trait Sealed {}
}