Struct Period 

pub struct Period { /* private fields */ }

How long a dashboard looks back: 7d, 30d, 90d (any number of days up to 366), 12w (weeks up to 104), 12m (months up to 36), mtd (this month so far), ytd (this year so far), or a custom range of dates (2026-09-01..2026-09-30, both days included, at most 1,096 days), in APP_TIMEZONE.

As an extractor it reads ?period=, or ?period=custom&from=2026-09-01&to=2026-09-30 (what the kit’s period_filter sends for a custom range); anything it can’t read (an unknown key, a date that isn’t one, from after to, a range over three years) gives the default, 30 days. It serializes as its key ("30d", "2026-09-01..2026-09-30"), which period_filter takes.

Implementations

impl Period

pub fn days(n: u32) -> Self

The last n days, today included.

pub fn weeks(n: u32) -> Self

The last n weeks, this one so far included: from the Monday n - 1 weeks before this week’s Monday, to today. Per week.

pub fn months(n: u32) -> Self

The last n months, this one included.

pub fn month_to_date() -> Self

This month so far.

pub fn year_to_date() -> Self

This year so far.

pub fn between(from: NaiveDate, to: NaiveDate) -> Option<Self>

From from to to, both days included (local days in APP_TIMEZONE). None when from is after to or the range is longer than 1,096 days (three years).

pub fn per(self, bucket: Bucket) -> Self

The same period, but per bucket instead of the step it picks itself (bucket): Period::days(90).per(Bucket::Week).

pub fn parse(key: &str) -> Option<Self>

"7d", "12w", "12m", "mtd", "ytd" or "2026-09-01..2026-09-30"; None for anything else.

pub fn key(&self) -> String

The key it parses from: "30d", or "2026-09-01..2026-09-30" for a custom range.

pub fn is_custom(&self) -> bool

Whether it is a custom range of dates (between).

pub fn previous(self) -> Self

The period just before, as long: the 30 days before the last 30, last month to the same day, last year to the same day, as many days just before a custom range. For comparisons (Series::change_from).

pub fn bucket(&self) -> Bucket

Per day up to 92 days (and month to date), per week for 12w-style periods and custom ranges up to 26 weeks, else per month; or what per set.

pub fn range(&self, zone: Zone) -> (DateTime, DateTime)

The moments the period starts at and ends before, in zone.

pub fn labels(&self, zone: Zone) -> Vec<String>

The labels of its buckets, in order: 2026-10-02 per day, the week’s Monday (2026-09-28) per week, 2026-10 per month.

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 Default for Period

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Period

impl<S: Send + Sync> FromRequestParts<S> for Period

type Rejection = !

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

impl PartialEq for Period

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Period

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Period