Enum Algorithm 

#[non_exhaustive]
pub enum Algorithm {
    TokenBucket,
    LeakyBucket,
    FixedWindow,
    SlidingWindowLog,
    SlidingWindowCounter,
}

Selects the algorithm a limiter uses to decide a request.

Every algorithm shares the same Limiter surface, so the strategy can change without touching call sites. This enum is the selector a future builder uses to pick between them.

#[non_exhaustive]: algorithms are added over the 0.x series, so a match must include a wildcard arm. TokenBucket — the default — is always available; the leaky bucket and the window algorithms are compiled in under the algorithms feature, so their variants only exist when it is enabled.

Examples

use rate_net::Algorithm;

// The default is the token bucket — smooth refill with burst headroom.
assert_eq!(Algorithm::default(), Algorithm::TokenBucket);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TokenBucket

Smooth refill with burst headroom up to the configured capacity. The general-purpose default; delegates its accounting to better-bucket.

LeakyBucket

Constant-drain shaping that smooths bursts to a steady output rate. Requires the algorithms feature.

FixedWindow

A counter that resets each window; cheapest, tolerates boundary bursts. Requires the algorithms feature.

SlidingWindowLog

Exact request timestamps within the trailing window; highest accuracy, higher memory. Requires the algorithms feature.

SlidingWindowCounter

A weighted blend of the current and previous window; an accuracy/cost balance and a common production choice. Requires the algorithms feature.

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Default for Algorithm

fn default() -> Algorithm

Returns the “default value” for a type.

impl Hash for Algorithm

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Algorithm

fn eq(&self, other: &Algorithm) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm