Struct GregorianDate

pub struct GregorianDate { /* private fields */ }

Gregorian Calendar date (proleptic).

The implementation for the Gregorian Calendar is very slim and intentionally doesn’t have a dedicated month type or support weekdays. It’s only here to allow conversions from the Gregorian Calendar to SAC13 and vice-versa. If you want better typing for the Gregorian Calender check out the crates chrono and time.

BC years

This proleptic Gregorian Calendar implementation uses astronomical year numbering, which means that zero and negative years to represent BC years.

• 0 => 1 BC
• -1 => 2 BC
• -2 => 3 BC
• etc.

Implementations

impl GregorianDate

pub const MIN: Self

Earliest representable date: -10’000-03-22

Corresponds to A000-01-01 in SAC13. We only allow GregorianDates that have a corresponding SAC13 date to simplify the API.

pub const MAX: Self

Latest representable date: 16’000-03-17

Corresponds to Z999-13-29 in SAC13. We only allow GregorianDates that have a corresponding SAC13 date to simplify the API.

pub fn parse_str(input: &str) -> Option<ParsedGregorianDate>

Tries to parse a Gregorian Calendar date.

For details about the supported formats see SacOrGreg::parse_str.

pub const fn from_ymd(year: i16, month: u8, day: u8) -> Option<Self>

Creates a Gregorian Calendar date from its components year, month and day.

Returns None if the given date is invalid (doesn’t exist in the Gregorian Calendar), like day zero or August 32th, or February 29th on non-leap (common) years.

It also returns None if the date is outside the supported SAC13 range (see GregorianDate::MIN and GregorianDate::MAX).

pub const fn is_leap_year(year: i16) -> bool

Returns true if the given year is a leap year in the proleptic Gregorian Calendar.

The current implementation also covers years outside the range GregorianDate::MIN - GregorianDate::MAX but don’t rely on that because this might change without a major version bump.

pub const fn month_len(year: i16, month: u8) -> Option<u8>

Determines the length of a month in days for a given year and month pair.

Returns None for invalid combinations (like the months > 12).

The current implementation also covers years outside the range GregorianDate::MIN - GregorianDate::MAX but don’t rely in that because this might change without a major version bump.

pub const fn year(&self) -> i16

The year component of the date. For limits see GregorianDate::MIN and GregorianDate::MAX.

pub const fn month(&self) -> u8

The month component of the date. Values: 1 (Junary) - 12 (December).

pub const fn day(&self) -> u8

The day component of the date. Values: 1 - 31.

Trait Implementations

impl CalendarDate for GregorianDate

const MIN: Self = Self::MIN

Earliest representable date.

const MAX: Self = Self::MAX

Latest representable date.

fn as_julian(&self) -> i32

Convert the date into the corresponding Julian Day Number.

fn from_julian(value: i32) -> Option<Self>

Get the date from the corresponding Julian

fn tomorrow(self) -> Option<Self>

Gets the next date.

fn yesterday(self) -> Option<Self>

Gets the previous date.

fn convert<T: CalendarDate>(self) -> T

Converts the calendar date to a different calendar system.

impl Clone for GregorianDate

fn clone(&self) -> GregorianDate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GregorianDate

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

Formats the value using the given formatter.

impl Display for GregorianDate

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

Formats the value using the given formatter.

impl Hash for GregorianDate

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 GregorianDate

fn cmp(&self, other: &GregorianDate) -> 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 GregorianDate

fn eq(&self, other: &GregorianDate) -> 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 GregorianDate

fn partial_cmp(&self, other: &GregorianDate) -> 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 Copy for GregorianDate

impl Eq for GregorianDate

impl StructuralPartialEq for GregorianDate