Struct Date 

pub struct Date { /* private fields */ }

A proleptic Gregorian calendar date stored as days since 1970-01-01.

Ordering and equality are by serial number, so they coincide with calendar order. The type is Copy and cheap to pass by value.

Implementations

impl Date

pub fn new(year: i32, month: u32, day: u32) -> Result<Self, DateError>

Constructs a date from a calendar (year, month, day).

month is 1–12, day is 1–days_in_month. Returns DateError::InvalidDate for any out-of-range or nonexistent date (e.g. month 13, day 0, or February 30).

Errors

Returns DateError::InvalidDate if the triple is not a real date.

pub fn from_serial(serial: i32) -> Self

Constructs a date directly from its serial number (days since 1970-01-01). Always valid; provided for round-tripping and arithmetic.

pub fn serial(self) -> i32

The serial number: days since 1970-01-01 (negative before the epoch).

Day-count year fractions for actual/N conventions are (b.serial() - a.serial()) divided by the convention’s basis.

pub fn year(self) -> i32

Calendar year.

pub fn month(self) -> u32

Calendar month, 1–12.

pub fn day(self) -> u32

Day of month, 1–31.

pub fn ymd(self) -> (i32, u32, u32)

(year, month, day) in one call (one serial conversion instead of three).

pub fn weekday(self) -> Weekday

Day of the week.

pub fn is_weekend(self) -> bool

True if the date falls on a Saturday or Sunday. Holiday calendars (a later phase) extend this with named holidays per market.

pub fn is_leap_year(self) -> bool

True if the date’s year is a Gregorian leap year.

pub fn add_days(self, n: i32) -> Self

Returns this date advanced by n days (negative moves backward).

pub fn days_until(self, other: Self) -> i32

Signed number of days from self to other (other - self).

pub fn end_of_month(self) -> Self

The last day of this date’s month, preserving year and month.

pub fn is_end_of_month(self) -> bool

True if this date is the last day of its month.

pub fn add_period(self, period: Period) -> Self

Returns this date advanced by period (negative periods move backward).

Days/weeks add a fixed day count. Months/years use calendar arithmetic with end-of-month clamping (see Period).

Trait Implementations

impl Add<Period> for Date

type Output = Date

The resulting type after applying the + operator.

fn add(self, period: Period) -> Date

Performs the + operation.

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

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

ISO 8601 YYYY-MM-DD.

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.

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

impl Sub for Date

type Output = i32

Difference in days (self - rhs).

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

Performs the - operation.

impl Sub<Period> for Date

type Output = Date

The resulting type after applying the - operator.

fn sub(self, period: Period) -> Date

Performs the - operation.