Struct governor::middleware::StateInformationMiddleware

pub struct StateInformationMiddleware;

Middleware that returns the state of the rate limiter if a positive decision is reached.

Trait Implementations

impl Debug for StateInformationMiddleware

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

Formats the value using the given formatter.

impl<P: Reference> RateLimitingMiddleware<P> for StateInformationMiddleware

type PositiveOutcome = StateSnapshot

The state snapshot returned from the limiter.

type NegativeOutcome = NotUntil<P>

The type that’s returned by the rate limiter when a cell is not allowed.

fn allow<K>(_key: &K, state: impl Into<StateSnapshot>) -> Self::PositiveOutcome

Called when a positive rate-limiting decision is made.

fn disallow<K>(
    _key: &K,
    state: impl Into<StateSnapshot>,
    start_time: P
) -> Self::NegativeOutcome

Called when a negative rate-limiting decision is made (the “not allowed but OK” case).