Struct GCRA 

pub struct GCRA;

GCRA (Generic Cell Rate Algorithm) rate limiter.

This is the recommended algorithm for most use cases, offering:

• Precise rate control with even request spacing
• Low memory usage
• Excellent burst handling
• Clear “retry after” semantics

Example

use oc_ratelimit_advanced::{GCRA, Quota, MemoryStorage};
use std::time::Duration;

let algorithm = GCRA::new();
let storage = MemoryStorage::new();
let quota = Quota::per_second(10).with_burst(15);

let decision = algorithm.check_and_record(&storage, "user:123", &quota).await?;

Implementations

impl GCRA

pub fn new() -> Self

Create a new GCRA algorithm instance.

Trait Implementations

impl Algorithm for GCRA

fn name(&self) -> &'static str

Get the algorithm name (for logging/metrics).

async fn check_and_record<S: Storage>( &self, storage: &S, key: &str, quota: &Quota, ) -> Result<Decision>

Check if a request is allowed AND record it atomically.

async fn check<S: Storage>( &self, storage: &S, key: &str, quota: &Quota, ) -> Result<Decision>

Check without recording (peek at current state).

fn reset<S: Storage>( &self, storage: &S, key: &str, ) -> impl Future<Output = Result<()>> + Send

Reset the rate limit for a key.

impl Clone for GCRA

fn clone(&self) -> GCRA

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GCRA

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GCRA

fn default() -> GCRA

Returns the “default value” for a type.