Struct Date 

pub struct Date { /* private fields */ }

A day in the proleptic Gregorian calendar.

Fields are private and Date::new is checked, so nothing downstream — including the grid below — ever has to ask whether a date is real. Ordering is chronological, which is what the field order buys.

Implementations

impl Date

pub fn new(year: i32, month: u8, day: u8) -> Option<Self>

None unless the day exists: month in 1..=12, day within that month’s own length, in that year — so 29 February answers differently depending on the year, which is the whole point of asking.

pub fn year(self) -> i32

pub fn month(self) -> u8

pub fn day(self) -> u8

pub fn to_days(self) -> i64

Days since 1970-01-01, negative before it.

Howard Hinnant’s days_from_civil, transcribed rather than re-derived (http://howardhinnant.github.io/date_algorithms.html, public domain). It is exact across the whole proleptic Gregorian range, and every other operation here is a round trip through it and its inverse — so there is one piece of calendar arithmetic in this file, not six.

pub fn from_days(days: i64) -> Self

The inverse of Date::to_days — Hinnant’s civil_from_days. Total by construction: every integer is a day.

pub fn add_days(self, days: i64) -> Self

pub fn add_months(self, months: i32) -> Self

Whole months, keeping the day where the target month has one: 31 January plus a month is 28 February, not 3 March. Clamping is what a calendar’s month arrows mean — adding thirty days is a different question.

pub fn weekday(self) -> Weekday

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Date

impl Debug for Date

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

Formats the value using the given formatter.

impl Display for Date

ISO 8601, because it is the one written form no locale argues with and it sorts. An app wanting “17 Aug” formats it from the accessors — that is its call to make, not a component library’s.

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

Formats the value using the given formatter.

impl Eq for Date

impl Hash for Date

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Date

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Date

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Date

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Date