Struct time::Date

pub struct Date { /* fields omitted */ }

Date in the proleptic Gregorian calendar.

By default, years between ±9999 inclusive are representable. This can be expanded to ±999,999 inclusive by enabling the large-dates crate feature. Doing so has performance implications and introduces some ambiguities when parsing.

Implementations

impl Date

pub const MIN: Self

The minimum valid Date.

The value of this may vary depending on the feature flags enabled.

pub const MAX: Self

The maximum valid Date.

The value of this may vary depending on the feature flags enabled.

pub const fn from_calendar_date(
    year: i32,
    month: u8,
    day: u8
) -> Result<Self, ComponentRange>

Attempt to create a Date from the year, month, and day.

assert!(Date::from_calendar_date(2019, 1, 1).is_ok());
assert!(Date::from_calendar_date(2019, 12, 31).is_ok());

assert!(Date::from_calendar_date(2019, 2, 29).is_err()); // 2019 isn't a leap year.

pub const fn from_ordinal_date(
    year: i32,
    ordinal: u16
) -> Result<Self, ComponentRange>

Attempt to create a Date from the year and ordinal day number.

assert!(Date::from_ordinal_date(2019, 1).is_ok());
assert!(Date::from_ordinal_date(2019, 365).is_ok());

assert!(Date::from_ordinal_date(2019, 366).is_err()); // 2019 isn't a leap year.

pub const fn from_iso_week_date(
    year: i32,
    week: u8,
    weekday: Weekday
) -> Result<Self, ComponentRange>

Attempt to create a Date from the ISO year, week, and weekday.

assert!(Date::from_iso_week_date(2019, 1, Monday).is_ok());
assert!(Date::from_iso_week_date(2019, 1, Tuesday).is_ok());
assert!(Date::from_iso_week_date(2020, 53, Friday).is_ok());

assert!(Date::from_iso_week_date(2019, 53, Monday).is_err()); // 2019 doesn't have 53 weeks.

pub const fn from_julian_day(julian_day: i32) -> Result<Self, ComponentRange>

Create a Date from the Julian day.

The algorithm to perform this conversion is derived from one provided by Peter Baum; it is freely available here.

assert_eq!(Date::from_julian_day(0), Ok(date!("-4713-11-24")));
assert_eq!(Date::from_julian_day(2_451_545), Ok(date!("2000-01-01")));
assert_eq!(Date::from_julian_day(2_458_485), Ok(date!("2019-01-01")));
assert_eq!(Date::from_julian_day(2_458_849), Ok(date!("2019-12-31")));

pub const fn year(self) -> i32

Get the year of the date.

assert_eq!(date!("2019-01-01").year(), 2019);
assert_eq!(date!("2019-12-31").year(), 2019);
assert_eq!(date!("2020-01-01").year(), 2020);

pub const fn month(self) -> u8

Get the month.

The returned value will always be in the range 1..=12.

assert_eq!(date!("2019-01-01").month(), 1);
assert_eq!(date!("2019-12-31").month(), 12);

pub const fn day(self) -> u8

Get the day of the month.

The returned value will always be in the range 1..=31.

assert_eq!(date!("2019-01-01").day(), 1);
assert_eq!(date!("2019-12-31").day(), 31);

pub const fn ordinal(self) -> u16

Get the day of the year.

The returned value will always be in the range 1..=366 (1..=365 for common years).

assert_eq!(date!("2019-01-01").ordinal(), 1);
assert_eq!(date!("2019-12-31").ordinal(), 365);

pub const fn iso_week(self) -> u8

Get the ISO week number.

The returned value will always be in the range 1..=53.

assert_eq!(date!("2019-01-01").iso_week(), 1);
assert_eq!(date!("2019-10-04").iso_week(), 40);
assert_eq!(date!("2020-01-01").iso_week(), 1);
assert_eq!(date!("2020-12-31").iso_week(), 53);
assert_eq!(date!("2021-01-01").iso_week(), 53);

pub const fn sunday_based_week(self) -> u8

Get the week number where week 1 begins on the first Sunday.

The returned value will always be in the range 0..=53.

assert_eq!(date!("2019-01-01").sunday_based_week(), 0);
assert_eq!(date!("2020-01-01").sunday_based_week(), 0);
assert_eq!(date!("2020-12-31").sunday_based_week(), 52);
assert_eq!(date!("2021-01-01").sunday_based_week(), 0);

pub const fn monday_based_week(self) -> u8

Get the week number where week 1 begins on the first Monday.

The returned value will always be in the range 0..=53.

assert_eq!(date!("2019-01-01").monday_based_week(), 0);
assert_eq!(date!("2020-01-01").monday_based_week(), 0);
assert_eq!(date!("2020-12-31").monday_based_week(), 52);
assert_eq!(date!("2021-01-01").monday_based_week(), 0);

pub const fn to_calendar_date(self) -> (i32, u8, u8)

Get the year, month, and day.

assert_eq!(date!("2019-01-01").to_calendar_date(), (2019, 1, 1));

pub const fn to_ordinal_date(self) -> (i32, u16)

Get the year and ordinal day number.

assert_eq!(date!("2019-01-01").to_ordinal_date(), (2019, 1));

pub const fn to_iso_week_date(self) -> (i32, u8, Weekday)

Get the ISO 8601 year, week number, and weekday.

assert_eq!(date!("2019-01-01").to_iso_week_date(), (2019, 1, Tuesday));
assert_eq!(date!("2019-10-04").to_iso_week_date(), (2019, 40, Friday));
assert_eq!(date!("2020-01-01").to_iso_week_date(), (2020, 1, Wednesday));
assert_eq!(date!("2020-12-31").to_iso_week_date(), (2020, 53, Thursday));
assert_eq!(date!("2021-01-01").to_iso_week_date(), (2020, 53, Friday));

pub const fn weekday(self) -> Weekday

Get the weekday.

assert_eq!(date!("2019-01-01").weekday(), Tuesday);
assert_eq!(date!("2019-02-01").weekday(), Friday);
assert_eq!(date!("2019-03-01").weekday(), Friday);
assert_eq!(date!("2019-04-01").weekday(), Monday);
assert_eq!(date!("2019-05-01").weekday(), Wednesday);
assert_eq!(date!("2019-06-01").weekday(), Saturday);
assert_eq!(date!("2019-07-01").weekday(), Monday);
assert_eq!(date!("2019-08-01").weekday(), Thursday);
assert_eq!(date!("2019-09-01").weekday(), Sunday);
assert_eq!(date!("2019-10-01").weekday(), Tuesday);
assert_eq!(date!("2019-11-01").weekday(), Friday);
assert_eq!(date!("2019-12-01").weekday(), Sunday);

pub const fn next_day(self) -> Option<Self>

Get the next calendar date.

assert_eq!(date!("2019-01-01").next_day(), Some(date!("2019-01-02")));
assert_eq!(date!("2019-01-31").next_day(), Some(date!("2019-02-01")));
assert_eq!(date!("2019-12-31").next_day(), Some(date!("2020-01-01")));
assert_eq!(Date::MAX.next_day(), None);

pub const fn previous_day(self) -> Option<Self>

Get the previous calendar date.

assert_eq!(
    date!("2019-01-02").previous_day(),
    Some(date!("2019-01-01"))
);
assert_eq!(
    date!("2019-02-01").previous_day(),
    Some(date!("2019-01-31"))
);
assert_eq!(
    date!("2020-01-01").previous_day(),
    Some(date!("2019-12-31"))
);
assert_eq!(Date::MIN.previous_day(), None);

pub const fn to_julian_day(self) -> i32

Get the Julian day for the date.

The algorithm to perform this conversion is derived from one provided by Peter Baum; it is freely available here.

assert_eq!(date!("-4713-11-24").to_julian_day(), 0);
assert_eq!(date!("2000-01-01").to_julian_day(), 2_451_545);
assert_eq!(date!("2019-01-01").to_julian_day(), 2_458_485);
assert_eq!(date!("2019-12-31").to_julian_day(), 2_458_849);

impl Date

Methods to add a Time component, resulting in a PrimitiveDateTime.

pub const fn midnight(self) -> PrimitiveDateTime

Create a PrimitiveDateTime using the existing date. The Time component will be set to midnight.

assert_eq!(date!("1970-01-01").midnight(), datetime!("1970-01-01 0:00"));

pub const fn with_time(self, time: Time) -> PrimitiveDateTime

Create a PrimitiveDateTime using the existing date and the provided Time.

assert_eq!(
    date!("1970-01-01").with_time(time!("0:00")),
    datetime!("1970-01-01 0:00"),
);

pub const fn with_hms(
    self,
    hour: u8,
    minute: u8,
    second: u8
) -> Result<PrimitiveDateTime, ComponentRange>

Attempt to create a PrimitiveDateTime using the existing date and the provided time.

assert!(date!("1970-01-01").with_hms(0, 0, 0).is_ok());
assert!(date!("1970-01-01").with_hms(24, 0, 0).is_err());

pub const fn with_hms_milli(
    self,
    hour: u8,
    minute: u8,
    second: u8,
    millisecond: u16
) -> Result<PrimitiveDateTime, ComponentRange>

Attempt to create a PrimitiveDateTime using the existing date and the provided time.

assert!(date!("1970-01-01").with_hms_milli(0, 0, 0, 0).is_ok());
assert!(date!("1970-01-01").with_hms_milli(24, 0, 0, 0).is_err());

pub const fn with_hms_micro(
    self,
    hour: u8,
    minute: u8,
    second: u8,
    microsecond: u32
) -> Result<PrimitiveDateTime, ComponentRange>

Attempt to create a PrimitiveDateTime using the existing date and the provided time.

assert!(date!("1970-01-01").with_hms_micro(0, 0, 0, 0).is_ok());
assert!(date!("1970-01-01").with_hms_micro(24, 0, 0, 0).is_err());

pub const fn with_hms_nano(
    self,
    hour: u8,
    minute: u8,
    second: u8,
    nanosecond: u32
) -> Result<PrimitiveDateTime, ComponentRange>

Attempt to create a PrimitiveDateTime using the existing date and the provided time.

assert!(date!("1970-01-01").with_hms_nano(0, 0, 0, 0).is_ok());
assert!(date!("1970-01-01").with_hms_nano(24, 0, 0, 0).is_err());

impl Date

pub fn format_into(
    self,
    output: &mut impl Write,
    format: &impl Formattable
) -> Result<usize, Format>

This is supported on crate feature formatting only.

Format the Date using the provided format description. The formatted value will be output to the provided writer. The format description will typically be parsed by using format_description::parse.

pub fn format(self, format: &impl Formattable) -> Result<String, Format>

This is supported on crate feature formatting only.

Format the Date using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[year]-[month]-[day]")?;
assert_eq!(date!("2020-01-02").format(&format)?, "2020-01-02");

impl Date

pub fn parse(input: &str, description: &impl Parsable) -> Result<Self, Parse>

This is supported on crate feature parsing only.

Parse a Date from the input using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[year]-[month]-[day]")?;
assert_eq!(Date::parse("2020-01-02", &format)?, date!("2020-01-02"));

Trait Implementations

impl Add<Duration> for Date

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: Duration) -> Self::Output

Performs the + operation.

impl Add<Duration> for Date

type Output = Self

The resulting type after applying the + operator.

fn add(self, duration: StdDuration) -> Self::Output

Performs the + operation.

impl<T> AddAssign<T> for Date where
    Self: Add<T, Output = Self>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Arbitrary for Date

This is supported on crate feature quickcheck only.

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl Clone for Date

fn clone(&self) -> Date

Returns a copy of the value.

pub 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<(), Error>

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for Date

This is supported on crate feature serde only.

fn deserialize<D: Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Date

This is supported on crate feature formatting only.

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.

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

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.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Date> for Date

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Date> for Date

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Serialize for Date

This is supported on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Date

impl StructuralPartialEq for Date

impl Sub<Date> for Date

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl Sub<Duration> for Date

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: Duration) -> Self::Output

Performs the - operation.

impl Sub<Duration> for Date

type Output = Self

The resulting type after applying the - operator.

fn sub(self, duration: StdDuration) -> Self::Output

Performs the - operation.

impl<T> SubAssign<T> for Date where
    Self: Sub<T, Output = Self>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl TryFrom<Parsed> for Date

This is supported on crate feature parsing only.

type Error = TryFromParsed

The type returned in the event of a conversion error.

fn try_from(parsed: Parsed) -> Result<Self, Self::Error>

Performs the conversion.