Enum Period 

pub enum Period {
    CalendarMonthUtc,
    Anchored {
        anchor: OffsetDateTime,
        every: Months,
    },
    Day,
}

How a period is cut. Every variant converts to UTC first, so an instant in any offset names the same window as its UTC spelling.

Variants

CalendarMonthUtc

The UTC calendar month.

Anchored

A cycle anchored on a subscription’s start: period k starts at anchor + k * every months, recomputed from the anchor every time, never chained, the day clamped to the target month’s last day and the anchor’s UTC time-of-day kept. An anchor on Jan 31 gives Feb 28 (Feb 29 in a leap year), then Mar 31, then Apr 30 — each clamp remembered only for the month that needs it. A now before the anchor uses floor division (a negative k).

Fields

anchor: OffsetDateTime

every: Months

Day

The UTC calendar day.

Implementations

impl Period

pub fn window_at(self, now: OffsetDateTime) -> PeriodWindow

The window containing now.

pub fn index_at(self, now: OffsetDateTime) -> i64

The period index containing now: what window_for inverts and what history and purge step over.

pub fn window_for(self, index: i64) -> PeriodWindow

The window with this index: window_for(index_at(now)) == window_at(now). An index at either extreme of the i64 range saturates rather than overflowing (see month_index_bounds).

Trait Implementations

impl Clone for Period

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Period

impl Debug for Period

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

Formats the value using the given formatter.

impl Eq for Period

impl PartialEq for Period

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Period