Struct irox_time::gregorian::Date

pub struct Date { /* private fields */ }

Gregorian Date - a specific date on a calendar.

Implementations

impl Date

pub fn new( year: i32, day_of_year: u16 ) -> Result<Date, GreaterThanEqualToValueError<u16>>

Constructs a new date given the provided gregorian year and day of year. Returns Err(GreaterThanEqualToValueError) if day_of_year is outside the valid range.

pub fn try_from_values( year: i32, month: u8, day: u8 ) -> Result<Date, GreaterThanEqualToValueError<u8>>

Constructs a new date given the provided values. If month or day is out of range, will return Err(OutsideRangeError).

Note: The ‘day’ parameter here is in the range of 1..=31 as would be shown on a calendar

pub fn try_from( year: i32, month: Month, day: u8 ) -> Result<Date, GreaterThanEqualToValueError<u8>>

Constructs a new date given the provided values, if day is out of range, will return Err(OutsideRangeError)

Note: The ‘day’ parameter here is in the range of 1..=31 as would be shown on a calendar

pub fn year(&self) -> i32

Returns the gregorian year this date represents

pub fn day_of_year_offset(&self) -> u16

Returns the day offset into the year. January 1 is ‘0’, January 31 is ‘30’, February 1 is ‘31’, and so on.

pub fn day_of_year(&self) -> u16

Returns the calendar day of the year. January 1 is ‘1’, January 31 is ‘31’, February 1 is ‘32’, and so on.

pub fn month_of_year(&self) -> Month

Returns the Month this date is contained within

pub fn day_of_month(&self) -> u8

Returns the day index into the current month in the range [0,31)

pub fn add_days(&self, days: u32) -> Date

Adds the specified number of days to this date.

pub fn sub_days(&self, days: u16) -> Date

Subtracts the given number of days from this date

pub fn add_years(&self, years: u16) -> Date

Adds the specified number of years to this date.

pub fn sub_years(&self, years: u16) -> Date

Subtracts the specified number of years from this date.

pub fn as_unix_timestamp(&self) -> UnixTimestamp

Returns the UnixTimestamp of this Date

pub fn as_julian_day(&self) -> JulianDate

Returns the JulianDate of this date

pub fn format<F: Format<Self>>(&self, format: &F) -> String

Formats this date using the specified formatter

pub fn parse_from<F: FormatParser<Self>>( format: &F, string: &str ) -> Result<Self, FormatError>

Attempts to parse a date from the string using the specified formatter

pub fn day_of_week(&self) -> DayOfWeek

Returns the day-of-the-week name of this date, using ISO8601 convention that the week starts on Monday.

pub fn week_number(&self) -> (i32, u8)

Returns a pair (year number, week of year)

Trait Implementations

impl Add<&Duration> for Date

type Output = Date

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&mut Duration> for Date

type Output = Date

The resulting type after applying the + operator.

fn add(self, rhs: &mut Duration) -> Self::Output

Performs the + operation.

impl Add<Duration> for Date

type Output = Date

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&Duration> for Date

fn add_assign(&mut self, rhs: &Duration)

Performs the += operation.

impl AddAssign<Duration> for Date

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

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

fn default() -> Date

Returns the “default value” for a type.

impl Display for Date

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

Formats the value using the given formatter.

impl Format<Date> for BasicCalendarDate

fn format(&self, date: &Date) -> String

Implementation-specific format of a date or time

impl Format<Date> for ExtendedDateFormat

fn format(&self, date: &Date) -> String

Implementation-specific format of a date or time

impl Format<Date> for ISO8601Date

fn format(&self, date: &Date) -> String

Implementation-specific format of a date or time

impl Format<Date> for ISO8601WeekNumber

fn format(&self, date: &Date) -> String

Implementation-specific format of a date or time

impl FormatParser<Date> for BasicCalendarDate

fn try_from(&self, data: &str) -> Result<Date, FormatError>

Tries to parse the specified string into the resultant item.

impl FormatParser<Date> for ExtendedDateFormat

fn try_from(&self, data: &str) -> Result<Date, FormatError>

Tries to parse the specified string into the resultant item.

impl FormatParser<Date> for ISO8601Date

fn try_from(&self, data: &str) -> Result<Date, FormatError>

Tries to parse the specified string into the resultant item.

impl From<&Date> for JulianDate

fn from(value: &Date) -> Self

Converts to this type from the input type.

impl From<&Date> for UnixTimestamp

fn from(value: &Date) -> Self

Converts to this type from the input type.

impl From<&JulianDayNumber<JulianEpoch>> for Date

fn from(value: &JulianDate) -> Self

Converts to this type from the input type.

impl From<&Timestamp<UnixEpoch>> for Date

fn from(value: &UnixTimestamp) -> Self

Converts to this type from the input type.

impl From<Date> for JulianDate

fn from(value: Date) -> Self

Converts to this type from the input type.

impl From<JulianDayNumber<JulianEpoch>> for Date

fn from(value: JulianDate) -> Self

Converts to this type from the input type.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 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 Sub<&Date> for Date

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: &Date) -> Self::Output

Performs the - operation.

impl Sub for Date

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Date) -> Self::Output

Performs the - operation.

impl Copy for Date

impl Eq for Date

impl StructuralPartialEq for Date