Struct FixedWindowCounterBuilder 

pub struct FixedWindowCounterBuilder { /* private fields */ }

Builder for configuring and creating FixedWindowCounter instances.

FixedWindowCounterBuilder provides a fluent interface for configuring all aspects of a fixed window counter rate limiter. The precision and time source types are determined through the builder chain.

Implementations

impl FixedWindowCounterBuilder

pub fn builder() -> Self

Creates a new builder for configuring a FixedWindowCounter.

This is the preferred way to start building a FixedWindowCounter.

Returns

A new FixedWindowCounterBuilder ready for configuration

Examples

use rate_guard::{Millis, MockTimeSource, RateLimit};
use rate_guard::limits::FixedWindowCounterBuilder;
use std::time::Duration;

let counter = FixedWindowCounterBuilder::builder()
    .capacity(100)
    .window_duration(Duration::from_secs(60))
    .with_time(MockTimeSource::new())
    .with_precision::<Millis>()
    .build()
    .unwrap();

assert!(counter.try_acquire(50).is_ok());

pub fn capacity(self, capacity: Uint) -> Self

Sets the maximum capacity of the fixed window counter.

The capacity determines the maximum number of actions allowed within each fixed window.

Arguments

• capacity - Maximum number of actions allowed per window

Returns

Self for method chaining

pub fn window_duration(self, duration: Duration) -> Self

Sets the duration of each fixed window.

This determines how long each window lasts before resetting. Common values include minutes or hours for rate limiting APIs.

Arguments

• duration - Duration of each fixed window

Returns

Self for method chaining

pub fn with_time<T: TimeSource>( self, time_source: T, ) -> FixedWindowCounterBuilderWithTime<T>

Configures the time source for the fixed window counter.

This method sets the time source and returns a builder that can then configure the precision type.

Arguments

• time_source - The time source instance to use

Returns

A builder with time source configured

Trait Implementations

impl Debug for FixedWindowCounterBuilder

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

Formats the value using the given formatter.

impl Default for FixedWindowCounterBuilder

fn default() -> Self

Returns the “default value” for a type.