Skip to main content

Period

Enum Period 

Source
pub enum Period {
    Year(i32),
    Half(i32, u8),
    Quarter(i32, u8),
    Month(i32, u8),
    Week(i32, u8),
    Rolling(u32, NaiveDate),
}
Expand description

A named time window with period-over-period semantics.

Variants§

§

Year(i32)

§

Half(i32, u8)

§

Quarter(i32, u8)

§

Month(i32, u8)

§

Week(i32, u8)

§

Rolling(u32, NaiveDate)

Last N days ending on a date.

Implementations§

Source§

impl Period

Source

pub fn to_key(&self) -> String

Canonical key string: 2026, 2026-H1, 2026-Q1, 2026-01, 2026-W02, last-30.

Source

pub fn parse(text: &str) -> Result<Self>

Parse 2026, 2026-H1, 2026-Q1, 2026-01, 2026-M1, 2026-W02, last-N, this-*, previous-*.

Source

pub fn parse_with_reference(text: &str, reference: NaiveDate) -> Result<Self>

Parse with an explicit reference date (testable).

Source

pub fn date_range(&self) -> (NaiveDate, NaiveDate)

Inclusive (start, end) dates of the period.

Source

pub fn previous(&self) -> Period

The immediately preceding period of the same granularity.

Source

pub fn date_column(&self) -> &'static str

Which dim_date column equality-filters this period.

Source

pub fn position_column(&self) -> Option<&'static str>

The positional column for apples-to-apples truncation of the previous period. None for Rolling (always complete).

Source

pub fn days_elapsed(&self, reference: NaiveDate) -> i64

Days elapsed within the period as of a reference date.

Source

pub fn is_partial(&self, reference: NaiveDate) -> bool

Is the period still in progress at the reference date?

Source

pub fn effective_end_date(&self, reference: NaiveDate) -> NaiveDate

The period’s end capped at the reference date.

Source

pub fn column_for_key(key: &str) -> &'static str

Pick the dim_date column for an arbitrary period key string.

Trait Implementations§

Source§

impl Clone for Period

Source§

fn clone(&self) -> Period

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Period

Source§

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

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

impl PartialEq for Period

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Period

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> 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