Struct TimeWindowPolicy 

pub struct TimeWindowPolicy { /* private fields */ }

Time-window rate limiting policy.

Allows up to K events within a sliding time window. Events outside the window are automatically expired.

Example

use tracing_throttle::{TimeWindowPolicy, RateLimitPolicy};
use std::time::{Duration, Instant};

let mut policy = TimeWindowPolicy::new(2, Duration::from_secs(60)).unwrap();
let now = Instant::now();

// First 2 events allowed
assert!(policy.register_event(now).is_allow());
assert!(policy.register_event(now).is_allow());

// 3rd event suppressed (within window)
assert!(policy.register_event(now).is_suppress());

// After window expires, events are allowed again
let after_window = now + Duration::from_secs(61);
assert!(policy.register_event(after_window).is_allow());
assert!(policy.register_event(after_window).is_allow());

Implementations

impl TimeWindowPolicy

pub fn new( max_events: usize, window_duration: Duration, ) -> Result<Self, PolicyError>

Create a new time-window policy.

Arguments

• max_events - Maximum events allowed in the window (must be > 0)
• window_duration - Length of the sliding time window (must be > 0)

Errors

Returns PolicyError::ZeroMaxEvents if max_events is 0. Returns PolicyError::ZeroWindowDuration if window_duration is 0.

Trait Implementations

impl Clone for TimeWindowPolicy

fn clone(&self) -> TimeWindowPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeWindowPolicy

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

Formats the value using the given formatter.

impl PartialEq for TimeWindowPolicy

fn eq(&self, other: &TimeWindowPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RateLimitPolicy for TimeWindowPolicy

fn register_event(&mut self, timestamp: Instant) -> PolicyDecision

Register a new event occurrence and decide whether to allow or suppress it.

fn reset(&mut self)

Reset the policy state.

impl StructuralPartialEq for TimeWindowPolicy