Skip to main content

Period

Struct Period 

Source
pub struct Period {
    pub unit: Unit,
    pub start: NaiveDateTime,
}
Expand description

A calendar-aligned span of local time: one hour, day, ISO week (Mon–Sun) or month.

Fields§

§unit: Unit

How long the period is.

§start: NaiveDateTime

Its first moment, in local time (e.g. Monday 00:00 for a week).

Implementations§

Source§

impl Period

Source

pub fn containing(unit: Unit, at: NaiveDateTime) -> Self

The period of length unit that contains at.

Source

pub fn current(unit: Unit) -> Self

The period of length unit that contains now.

Source

pub fn end(self) -> NaiveDateTime

The first moment after the period (the start of the next one).

Source

pub fn next(self) -> Self

The following period of the same length.

Source

pub fn prev(self) -> Self

The preceding period of the same length.

Source

pub fn contains(self, at: NaiveDateTime) -> bool

Whether at falls inside the period.

Source

pub fn with_unit(self, unit: Unit) -> Self

Switches unit, staying around “now” if this period contains it.

Source

pub fn bounds(self) -> (DateTime<Local>, DateTime<Local>)

The period as a [start, end) range of local times.

Source

pub fn label(self) -> String

Human-readable name for titles, e.g. week 39 · Sep 21 – Sep 27 2026.

Source

pub fn columns(self) -> Vec<(String, Period)>

Sub-periods used as breakdown columns: days of a week, weeks of a month. Weeks that cross the month edge are included; callers clip them to the month.

Trait Implementations§

Source§

impl Clone for Period

Source§

fn clone(&self) -> Self

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

Source§

impl Debug for Period

Source§

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

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

impl Eq for Period

Source§

impl PartialEq for Period

Source§

fn eq(&self, other: &Self) -> 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<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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

Compare self to key and return true if they are equal.
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.