Struct DistributedRateLimiter 

pub struct DistributedRateLimiter<B: RateLimitBackend> { /* private fields */ }

Available on crate feature distributed-rate-limit only.

Shared rate limiter that works against pluggable backends.

Examples

use http_handle::distributed_rate_limit::{DistributedRateLimiter, InMemoryBackend};
let _limiter = DistributedRateLimiter::new(InMemoryBackend::default(), "ip", 100, 60);
assert_eq!(1, 1);

Panics

This type does not panic.

Implementations

impl<B: RateLimitBackend> DistributedRateLimiter<B>

pub fn new( backend: B, namespace: impl Into<String>, limit_per_window: u64, window_secs: u64, ) -> Self

Creates a distributed limiter with explicit namespace and limits.

Examples

use http_handle::distributed_rate_limit::{DistributedRateLimiter, InMemoryBackend};
let _ = DistributedRateLimiter::new(InMemoryBackend::default(), "ip", 10, 60);
assert_eq!(1, 1);

Panics

This function does not panic.

pub fn is_limited(&self, source: IpAddr) -> Result<bool, ServerError>

Returns true when the source should be throttled.

Examples

use http_handle::distributed_rate_limit::{DistributedRateLimiter, InMemoryBackend};
use std::net::IpAddr;
let limiter = DistributedRateLimiter::new(InMemoryBackend::default(), "ip", 1, 60);
let ip: IpAddr = "127.0.0.1".parse().expect("ip");
let _ = limiter.is_limited(ip);
assert_eq!(1, 1);

Errors

Returns backend errors when increment operations fail.

Panics

This function does not panic.

Trait Implementations

impl<B: Clone + RateLimitBackend> Clone for DistributedRateLimiter<B>

fn clone(&self) -> DistributedRateLimiter<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug + RateLimitBackend> Debug for DistributedRateLimiter<B>

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

Formats the value using the given formatter.