TimeUnit

Enum TimeUnit 

Source
pub enum TimeUnit {
    Seconds,
    Minutes,
    Hours,
    Days,
    Weeks,
    Months,
    Years,
    Ever,
}
Expand description

Time unit definitions for interval configuration.

Represents different time granularities for event counting.

§Calendar-Aligned Buckets vs Uniform Buckets

Default (calendar-aligned):

  • Buckets snap to calendar boundaries in local time
  • Days rotate at local midnight (12:00 AM)
  • Weeks rotate Monday at midnight
  • Months rotate on the 1st
  • Years rotate January 1st

Uniform buckets (disable calendar feature):

  • Buckets align to January 1st of the current year at 00:00 UTC
  • Days = 24-hour periods from that point
  • Weeks = 7-day periods
  • Months = 30-day periods (not calendar months)
  • Years = 365-day periods (ignores leap days)
  • All counters of the same time unit have aligned start times

§Why Calendar-Aligned by Default?

Best for client-side and user-facing use cases:

  • Aligns to how users talk: “today”, “this week”, “this month”
  • Day boundaries at local midnight (not arbitrary 24-hour windows)
  • Matches how users think: “I used the app 3 times today”
  • Works with daily/weekly/monthly goals and limits

Use uniform buckets (disable calendar feature) when you need:

  • Consistent bucket sizes for statistical analysis
  • Predictable memory usage (30 days ≈ 1 month)
  • Industry-standard “30-day rolling window” (backend analytics)
  • Better year approximation: 12 × 30 = 360 days (1.4% error vs 365)

TimeUnits are ordered from smallest to largest: Minutes < Hours < Days < Weeks < Months < Years < Ever

Ever is a special variant that represents “use the longest configured time unit for this event.” It is resolved lazily during query execution.

Variants§

§

Seconds

§

Minutes

§

Hours

§

Days

§

Weeks

§

Months

§

Years

§

Ever

Implementations§

Source§

impl TimeUnit

Source

pub fn duration(&self) -> Duration

Returns the duration represented by this time unit.

Note: Months use a 30-day approximation, Years use 365 days.

§Panics

Panics if called on TimeUnit::Ever, which has no fixed duration. Ever must be resolved to a concrete time unit before calling this method.

Trait Implementations§

Source§

impl Clone for TimeUnit

Source§

fn clone(&self) -> TimeUnit

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 TimeUnit

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TimeUnit

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<TimeUnit> for TimeWindow

Source§

fn from(unit: TimeUnit) -> Self

Converts to this type from the input type.
Source§

impl Hash for TimeUnit

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for TimeUnit

Source§

fn cmp(&self, other: &TimeUnit) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for TimeUnit

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for TimeUnit

Source§

fn partial_cmp(&self, other: &TimeUnit) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for TimeUnit

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for TimeUnit

Source§

impl Eq for TimeUnit

Source§

impl StructuralPartialEq for TimeUnit

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,