Struct ratelimit_meter::example_algorithms::Allower

pub struct Allower {}

The most naive implementation of a rate-limiter ever: Always allows every cell through.

Example

use ratelimit_meter::DirectRateLimiter;
use ratelimit_meter::example_algorithms::Allower;
let mut allower = Allower::ratelimiter();
assert!(allower.check().is_ok());

Implementations

impl Allower

pub fn ratelimiter() -> DirectRateLimiter<Allower>

Return a rate-limiter that lies, i.e. that allows all requests through.

Trait Implementations

impl Algorithm for Allower

fn test_n_and_update(
    &self,
    _state: &Self::BucketState,
    _n: u32,
    _t0: Instant
) -> Result<(), NegativeMultiDecision<Impossible>>

Allows all cells through unconditionally.

type BucketState = ()

The state of a single rate limiting bucket.

type NegativeDecision = Impossible

The type returned when a rate limiting decision for a single cell is negative. Each rate limiting algorithm can decide to return the type that suits it best, but most algorithms’ decisions also implement NonConformance, to ease handling of how long to wait.

fn construct(
    _capacity: NonZeroU32,
    _cell_weight: NonZeroU32,
    _per_time_unit: Duration
) -> Result<Self, InconsistentCapacity>

Constructs a rate limiter with the given parameters: capacity is the number of cells to allow, weighing cell_weight, every per_time_unit.

fn test_and_update(
    &self,
    state: &Self::BucketState,
    at: Instant
) -> Result<(), Self::NegativeDecision>

Tests if a single cell can be accommodated in the rate limiter at the instant at and updates the rate-limiter state to account for the weight of the cell.

impl Clone for Allower

fn clone(&self) -> Allower

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Allower

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

Formats the value using the given formatter.

impl Default for Allower

fn default() -> Allower

Returns the “default value” for a type.

impl RateLimitState<Allower> for ()

fn last_touched(&self, _params: &Allower) -> Instant

Returns the last time instant that the state had any relevance (i.e. the rate limiter would behave exactly as if it was a new rate limiter after this time).

impl Copy for Allower