Struct ratelimit_meter::state::keyed::Builder

pub struct Builder<K: Eq + Hash + Clone, C: Clock, A: Algorithm<C::Instant>, H: BuildHasher> { /* fields omitted */ }

A constructor for keyed rate limiters.

Methods

impl<K, C, A, H> Builder<K, C, A, H> where
    K: Eq + Hash + Clone,
    C: Clock,
    A: Algorithm<C::Instant>,
    A::BucketState: KeyableRateLimitState<A, C::Instant>,
    H: BuildHasher, 

pub fn with_hasher<H2: BuildHasher>(
    self,
    hash_builder: H2
) -> Builder<K, C, A, H2>

Sets the hashing method used for the map.

pub fn with_cell_weight(
    self,
    cell_weight: NonZeroU32
) -> Result<Self, InconsistentCapacity>

Sets the "weight" of each cell that is checked against the bucket.

pub fn with_map_capacity(self, map_capacity: usize) -> Self

Sets the initial number of keys that the map can hold before rehashing.

pub fn using_clock(self, clock: C) -> Self

Sets the clock used by the bucket.

pub fn build(self) -> Result<KeyedRateLimiter<K, A, C, H>, InconsistentCapacity> where
    H: Clone, 

Constructs a keyed rate limiter with the given options.

Trait Implementations

impl<K, A, C> Default for Builder<K, C, A, RandomState> where
    K: Eq + Hash + Clone,
    C: Clock,
    A: Algorithm<C::Instant>,
    A::BucketState: KeyableRateLimitState<A, C::Instant>, 

fn default() -> Builder<K, C, A, RandomState>

Returns the "default value" for a type.