Skip to main content

TimeBucketedCounter

Struct TimeBucketedCounter 

Source
pub struct TimeBucketedCounter<K> { /* private fields */ }
Available on crate feature tracker only.
Expand description

Per-key event counter over a sliding time window.

The window is divided into fixed-width buckets; counts are summed across buckets for queries. Lazily evicts buckets older than now - window on demand.

Implementations§

Source§

impl<K> TimeBucketedCounter<K>
where K: Hash + Eq + Clone,

Source

pub fn new(window: Duration, bucket_width: Duration, capacity: usize) -> Self

Construct a new counter.

window = total observation period; bucket_width = resolution; capacity = max distinct keys held across all buckets (best-effort, enforced by per-bucket cap).

bucket_width must be ≥ 1 ns; window should be ≥ bucket_width.

Source

pub fn new_unbounded(window: Duration, bucket_width: Duration) -> Self

Unbounded capacity convenience constructor — equivalent to Self::new(window, bucket_width, usize::MAX). Prefer Self::new with an explicit cap when memory pressure matters; this avoids the cap arithmetic in code paths that don’t need it. New in 0.12.0.

Source

pub fn bump(&mut self, key: K, now: Timestamp)

Increment the counter for key at now.

Source

pub fn count(&self, key: &K, now: Timestamp) -> u64

Sum counts for key across buckets within [now - window, now]. Buckets older than the window are excluded.

Source

pub fn entries_above( &self, threshold: u64, now: Timestamp, ) -> impl Iterator<Item = (&K, u64)> + '_

Iterate keys whose summed count is >= threshold over the active window.

Source

pub fn evict_expired(&mut self, now: Timestamp)

Drop buckets older than now - window.

Source

pub fn len(&self) -> usize

Current number of distinct keys held across all live buckets (approximate; double-counts a key that appears in multiple buckets).

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl<K: Debug> Debug for TimeBucketedCounter<K>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<K> Freeze for TimeBucketedCounter<K>

§

impl<K> RefUnwindSafe for TimeBucketedCounter<K>
where K: RefUnwindSafe,

§

impl<K> Send for TimeBucketedCounter<K>
where K: Send,

§

impl<K> Sync for TimeBucketedCounter<K>
where K: Sync,

§

impl<K> Unpin for TimeBucketedCounter<K>
where K: Unpin,

§

impl<K> UnsafeUnpin for TimeBucketedCounter<K>

§

impl<K> UnwindSafe for TimeBucketedCounter<K>
where K: UnwindSafe,

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> 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> Same for T

Source§

type Output = T

Should always be Self
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<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