Struct governor::state::InMemoryState

pub struct InMemoryState(_);

An in-memory representation of a GCRA's rate-limiting state.

Implemented using AtomicU64 operations, this state representation can be used to construct rate limiting states for other in-memory states: e.g., this crate uses InMemoryState as the states it tracks in the keyed rate limiters it implements.

Internally, the number tracked here is the theoretical arrival time (a GCRA term) in number of nanoseconds since the rate limiter was created.

Trait Implementations

impl Debug for InMemoryState

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

Formats the value using the given formatter.

impl Default for InMemoryState

fn default() -> InMemoryState

Returns the "default value" for a type.

impl StateStore for InMemoryState

The InMemoryState is the canonical "direct" state store.

type Key = NotKeyed

The type of key that the state store can represent.

fn measure_and_replace<T, F, E>(&self, _key: &Self::Key, f: F) -> Result<T, E> where
    F: Fn(Option<Nanos>) -> Result<(T, Nanos), E>, 

Updates a state store's rate limiting state for a given key, using the given closure.