Struct LayeredBuilder 

pub struct LayeredBuilder<K, E = K>
where
    K: Eq + Hash + Clone + Send + Sync + 'static,
    E: Eq + Hash + Clone + Send + Sync + 'static,
{ /* private fields */ }

Available on crate feature std only.

Builder for a Layered limiter.

Set any subset of the three scopes; omitted scopes simply do not constrain.

Examples

use throttle_net::{Layered, PerKey, Throttle};

let layered = Layered::<u64, String>::builder()
    .global(Throttle::per_second(1000))
    .per_key(PerKey::per_second(100))   // keyed by numeric tenant id
    .build();

Implementations

impl<K, E> LayeredBuilder<K, E>

where K: Eq + Hash + Clone + Send + Sync + 'static, E: Eq + Hash + Clone + Send + Sync + 'static,

pub fn global(self, limiter: impl Limiter + 'static) -> Self

Sets the global scope: one limiter shared by every request. Any Limiter works, so the global ceiling can itself be a Hybrid.

pub fn per_key<C>(self, limiter: PerKey<K, C>) -> Self

where C: Clock + Clone + 'static,

Sets the per-key scope: independent state per caller key. Accepts a PerKey built on any clock.

pub fn per_endpoint<C>(self, limiter: PerKey<E, C>) -> Self

where C: Clock + Clone + 'static,

Sets the per-endpoint scope: independent state per endpoint. Accepts a PerKey built on any clock.

pub fn build(self) -> Layered<K, E>

Builds the Layered limiter.