Struct GregorianDate 

pub struct GregorianDate { /* private fields */ }

Representation of a proleptic Gregorian date. Only represents logic down to single-day accuracy: i.e., leap days are included, but leap seconds are not. This is useful in keeping this calendar applicable to all different time scales. Can represent years from -2^31 up to 2^31 - 1.

This is the calendar effectively used by the hifitime and chrono libraries.

Implementations

impl GregorianDate

pub const fn new( year: i32, month: Month, day: u8, ) -> Result<Self, InvalidGregorianDate>

Creates a new Gregorian date, given its year, month, and day. If the date is not a valid proleptic Gregorian date, returns a GregorianDateDoesNotExist to indicate that the requested date does not exist in the proleptic Gregorian calendar.

This function will never panic.

pub const fn from_date(date: Date) -> Self

Constructs a Gregorian date from a given Date instance. Useful primarily when an existing Date must be printed in human-readable format.

Uses Howard Hinnant’s civil_from_days algorithm.

pub const fn into_date(&self) -> Date

Constructs a Date from a given Gregorian date. Uses Howard Hinnant’s days_from_civil algorithm.

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

Creates a new date given only the year and the day-of-year. Implementation is based on an algorithm found by A. Pouplier and reported by Jean Meeus in Astronomical Algorithms.

This function will never panic.

pub const fn year(&self) -> i32

Returns the year stored inside this proleptic Gregorian date. Astronomical year numbering is used (as also done in NAIF SPICE): the year 1 BCE is represented as 0, 2 BCE as -1, etc. Hence, around the year 0, the numbering is …, -2 (3 BCE), -1 (2 BCE), 0 (1 BCE), 1 (1 CE), 2 (2 CE), et cetera. In this manner, the year numbering proceeds smoothly through 0.

pub const fn month(&self) -> Month

Returns the month stored inside this proleptic Gregorian date.

pub const fn day(&self) -> u8

Returns the day-of-month stored inside this proleptic Gregorian date.

impl GregorianDate

pub fn parse_partial( string: &str, ) -> Result<(Self, &str), GregorianDateParsingError>

Parses a GregorianDate based on some string. Accepts only the extended complete calendar date format specified in ISO 8601 (see section 5.2.2.1), though in addition any number of digits is accepted for the years term - to extend applicability of the format to a larger time range.

On success, returns the resulting GregorianDate and any remaining input that was not yet parsed. On failure, returns a reason indicating why.

Trait Implementations

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 From<Date> for GregorianDate

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<GregorianDate> for Date

fn from(value: GregorianDate) -> Self

Converts to this type from the input type.

impl FromStr for GregorianDate

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

Parses a GregorianDate based on some string. Accepts only the extended complete calendar date format specified in ISO 8601 (see section 5.2.2.1), though in addition any number of digits is accepted for each term.

type Err = GregorianDateParsingError

The associated error which can be returned from parsing.

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