Struct gregorian::Date

pub struct Date { /* private fields */ }

A calendar date consting of a year, month and day.

All dates in the library use the proleptic Gregorian calendar with a year 0.

Implementations

impl Date

pub fn new<Y, M>(year: Y, month: M, day: u8) -> Result<Self, InvalidDate>where
    Y: Into<Year>,
    M: TryInto<Month>,
    InvalidDate: From<M::Error>,

Create a new date from a year, month and day.

Month and day numbers start at 1.

pub const fn new_const(
    year: Year,
    month: Month,
    day: u8
) -> Result<Self, InvalidDayOfMonth>

Create a new date from a year, month and day.

Day numbers start at 1.

pub const unsafe fn new_unchecked(year: Year, month: Month, day: u8) -> Self

Create a new date without checking the validity.

Month and day numbers start at 1.

Safety

Although this is currently not the case, future implementations may rely on date validity for memory safety

pub fn today() -> Self

Get the current date in the local time zone.

pub fn today_utc() -> Self

Get the current date of the UTC time zone.

pub const fn from_unix_timestamp(seconds: i64) -> Self

Get the date for a unix timestamp.

The timestamp is interpreted as number of seconds since 1 January 1970 00:00, not including any leap seconds.

pub const fn to_unix_timestamp(self) -> i64

Get the unix timestamp for a date.

The timestamp is the number of seconds since 1 January 1970 00:00.

The returned timestamp is valid for time 00:00 of the date.

pub const fn year(self) -> Year

Get the year.

pub const fn month(self) -> Month

Get the month.

pub const fn day(self) -> u8

Get the day of the month.

pub const fn year_month(self) -> YearMonth

Get the year and month as YearMonth.

pub const fn day_of_year(self) -> u16

Get the day of the year.

The returned number is 1-based. For January 1, this function will return 1.

pub const fn days_remaining_in_year(self) -> u16

The number of days remaining in the year, including the current date.

For Janury 1 this will return 365 in a non-leap year or 366 in a leap year. For December 31, this will return 1.

pub const fn days_since_year_zero(self) -> i32

Get the total number of days since 1 January 0000.

The returned value is zero-based. For 1 January 0000, this function returns 0.

pub const fn from_days_since_year_zero(days: i32) -> Self

Get the date corresponding to a number of days since the year zero.

For this function, day 0 is 1 January of year 0.

pub const fn next(self) -> Date

Get a Date object for the next day.

pub const fn prev(self) -> Date

Get a Date object for the previous day.

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

Compute a date by adding days.

pub const fn sub_days(self, days: i32) -> Self

Compute a date by subtracting days.

pub const fn add_months(self, months: i32) -> Result<Self, InvalidDayOfMonth>

Compute a date by adding a number of months.

The resulting date may not be valid. You can call InvalidDayOfMonth::next_valid() or InvalidDayOfMonth::prev_valid() to get the first day of the next month or the last day of resulting month.

pub const fn sub_months(self, months: i32) -> Result<Self, InvalidDayOfMonth>

Compute a date by subtracting a number of months.

The resulting date may not be valid. You can call InvalidDayOfMonth::next_valid() or InvalidDayOfMonth::prev_valid() to get the first day of the next month or the last day of resulting month.

pub const fn add_years(self, years: i16) -> Result<Self, InvalidDayOfMonth>

Compute a date by adding a number of years.

The resulting date may not be valid. You can call InvalidDayOfMonth::next_valid() or InvalidDayOfMonth::prev_valid() to get the first day of the next month or the last day of resulting month.

pub const fn sub_years(self, years: i16) -> Result<Self, InvalidDayOfMonth>

Compute a date by subtracting a number of years.

The resulting date may not be valid. You can call InvalidDayOfMonth::next_valid() or InvalidDayOfMonth::prev_valid() to get the first day of the next month or the last day of resulting month.

pub const fn days_since(self, other: Date) -> i32

Compute the difference in days between two dates.

This does not include the end date. For example, difference between the same date will be 0.

Trait Implementations

impl Clone for Date

fn clone(&self) -> Date

Returns a copy 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 Display for Date

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

Formats the value using the given formatter.

impl FromStr for Date

type Err = DateParseError

The associated error which can be returned from parsing.

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

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

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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<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: &Rhs) -> bool

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

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.

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

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

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

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

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

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

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

impl Eq for Date

impl StructuralEq for Date

impl StructuralPartialEq for Date