Struct Date 

pub struct Date(/* private fields */);

Our data uses imprecise dates in the “YYYY-MM-DD” format, with no timezone or time data.

Dates are stored as a packed u32 with 23 bits in use: (YYYY << YEAR_SHIFT) | (MM << MONTH_SHIFT) | (DD << DAY_SHIFT).

YEAR_SHIFT > MONTH_SHIFT > DAY_SHIFT, so that dates are properly ordered.

Implementations

impl Date

pub const fn from_parts(year: u32, month: u32, day: u32) -> Date

Creates a Date object from parts.

FIXME: Using this constructor bypasses error checks.

Examples

let date = Date::from_parts(1988, 02, 16);
assert_eq!(date.year(), 1988);
assert_eq!(date.month(), 2);
assert_eq!(date.day(), 16);

pub const fn year(self) -> u32

Returns the year as an integer.

Examples

let date = "1988-02-16".parse::<Date>().unwrap();
assert_eq!(date.year(), 1988);

pub const fn month(self) -> u32

Returns the month as an integer.

Examples

let date = "1988-02-16".parse::<Date>().unwrap();
assert_eq!(date.month(), 2);

pub const fn day(self) -> u32

Returns the day as an integer.

Examples

let date = "1988-02-16".parse::<Date>().unwrap();
assert_eq!(date.day(), 16);

pub const fn monthday(self) -> u32

Returns the month and day as a combined integer.

This is useful mostly for age calculations, where the monthday() corresponds to an exact day in the given year.

Examples

let date = "1988-02-16".parse::<Date>().unwrap();
assert_eq!(date.monthday(), 0216);

pub fn is_valid(self) -> bool

Determines whether a date exists in the Gregorian calendar.

Examples

let date = "2000-02-29".parse::<Date>().unwrap();
assert_eq!(date.is_valid(), true);

let date = "2018-04-31".parse::<Date>().unwrap();
assert_eq!(date.is_valid(), false);

pub fn age_on(self, date: Date) -> Result<Age, &'static str>

Calculates the Age of a lifter on a given date, where self is the lifter’s BirthDate.

Failures

Fails if the lifter was not yet born by the given date.

Fails if the lifter would be more than 256 years old.

Examples

let birthdate = "1991-12-16".parse::<Date>().unwrap();
let meetdate  = "2018-11-03".parse::<Date>().unwrap();
assert_eq!(birthdate.age_on(meetdate), Ok(Age::Exact(26)));

pub fn count_days(self) -> u32

Counts the number of days for the Date in the Common Era (0001-01-01).

This is used to provide a reference point to facilitate date math.

Examples

let first_day = "0001-01-01".parse::<Date>().unwrap();
assert_eq!(first_day.count_days(), 1); // The count is inclusive.

let special_day = "1982-06-11".parse::<Date>().unwrap();
assert_eq!(special_day.count_days(), 723_707);

The absolute day count is also used to enable Date subtraction:

let sixth = "2019-04-06".parse::<Date>().unwrap();
let fifth = "2019-04-05".parse::<Date>().unwrap();
assert_eq!(sixth - fifth, 1);

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 Debug for Date

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

Formats the value using the given formatter.

impl Default for Date

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Date

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Date, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Date

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

Formats the value using the given formatter.

impl FromStr for Date

type Err = ParseDateError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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.

impl PartialEq for Date

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 Serialize for Date

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

Serialize this value into the given Serde serializer.

impl Sub for Date

type Output = i32

The resulting type after applying the - operator.

fn sub(self, other: Date) -> i32

Performs the - operation.

impl Copy for Date

impl Eq for Date

impl StructuralPartialEq for Date