Skip to main content

SlidingWindow

Struct SlidingWindow 

Source
pub struct SlidingWindow { /* private fields */ }
Expand description

Sliding window rate limiter

Tracks events over a rolling time window, allowing precise rate limiting over time periods like “100 queries per minute”.

Implementations§

Source§

impl SlidingWindow

Source

pub fn new(window_size: Duration, max_events: u32) -> Self

Create a new sliding window

§Arguments
  • window_size - Duration of the sliding window
  • max_events - Maximum events allowed within the window
Source

pub fn per_second(max_events: u32) -> Self

Create a sliding window for events per second

Source

pub fn per_minute(max_events: u32) -> Self

Create a sliding window for events per minute

Source

pub fn per_hour(max_events: u32) -> Self

Create a sliding window for events per hour

Source

pub fn try_record(&self) -> Result<(), SlidingWindowExceeded>

Try to record an event

Returns Ok(()) if event was recorded, Err with wait time if limit exceeded.

Source

pub fn try_record_n(&self, count: u32) -> Result<(), SlidingWindowExceeded>

Try to record multiple events

Source

pub fn record_blocking( &self, timeout: Duration, ) -> Result<(), SlidingWindowExceeded>

Record an event, blocking until allowed (with timeout)

Source

pub fn current_count(&self) -> u32

Get current event count in window

Source

pub fn remaining_capacity(&self) -> u32

Get remaining capacity

Source

pub fn window_size(&self) -> Duration

Get window size

Source

pub fn max_events(&self) -> u32

Get max events

Source

pub fn utilization(&self) -> f64

Get utilization ratio (0.0 - 1.0)

Source

pub fn total_events(&self) -> u64

Get total events processed

Source

pub fn rejected_events(&self) -> u64

Get total events rejected

Source

pub fn rejection_rate(&self) -> f64

Get rejection rate (0.0 - 1.0)

Source

pub fn reset(&self)

Reset the sliding window

Source

pub fn current_rate(&self) -> f64

Get event rate (events per second)

Source

pub fn time_until_available(&self) -> Duration

Estimate time until an event can be recorded

Source

pub fn set_max_events(&mut self, max_events: u32)

Update max events (for dynamic limits)

Source

pub fn set_window_size(&mut self, window_size: Duration)

Update window size (for dynamic limits)

Trait Implementations§

Source§

impl Clone for SlidingWindow

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SlidingWindow

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more