Struct ratelimit_meter::example_algorithms::Always

pub struct Always();

A pseudo-instant that never changes.

It is used to implement the Allower rate-limiter type, which never denies any requests.

Trait Implementations

impl Algorithm<Always> for Allower

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_n_and_update(
    &self,
    _state: &Self::BucketState,
    _n: u32,
    _t0: Always
) -> Result<(), NegativeMultiDecision<Impossible>>

Allows all cells through unconditionally.

fn test_and_update(
    &self,
    state: &Self::BucketState,
    at: P
) -> 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 RateLimitState<Allower, Always> for ()

fn last_touched(&self, _params: &Allower) -> Option<Always>

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 Reference for Always

fn duration_since(&self, _other: Self) -> Duration

Determines the time that separates two measurements of a clock. Implementations of this must perform a saturating subtraction - if the earlier timestamp should be later, duration_since must return the zero duration.

fn saturating_sub(&self, _: Duration) -> Self

Returns a reference point that lies at most duration in the past from the current reference. If an underflow should occur, returns the current reference.

impl Clone for Always

fn clone(&self) -> Always

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Always> for Always

fn partial_cmp(&self, other: &Always) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Always

impl Eq for Always

impl Ord for Always

fn cmp(&self, other: &Always) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Always> for Always

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Always

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

Formats the value using the given formatter.

impl Sub<Duration> for Always

type Output = Always

The resulting type after applying the - operator.

fn sub(self, _rhs: Duration) -> Always

Performs the - operation.

impl Add<Duration> for Always

type Output = Always

The resulting type after applying the + operator.

fn add(self, _rhs: Duration) -> Always

Performs the + operation.