Struct icu_calendar::calendar_arithmetic::ArithmeticDate

pub(crate) struct ArithmeticDate<C: CalendarArithmetic> {
    pub year: i32,
    pub month: u8,
    pub day: u8,
    pub year_info: C::YearInfo,
    marker: PhantomData<C>,
}

Fields

year: i32

month: u8

1-based month of year

day: u8

1-based day of month

year_info: C::YearInfo

Invariant: MUST be updated to match the info for year whenever year is updated or set.

marker: PhantomData<C>

Implementations

impl<C: CalendarArithmetic> ArithmeticDate<C>

pub const fn new_unchecked(year: i32, month: u8, day: u8) -> Self

where C: CalendarArithmetic<YearInfo = ()>,

Create a new ArithmeticDate without checking that month and day are in bounds.

pub const fn new_unchecked_with_info( year: i32, month: u8, day: u8, year_info: C::YearInfo, ) -> Self

Create a new ArithmeticDate without checking that month and day are in bounds.

pub fn min_date() -> Self

where C: CalendarArithmetic<YearInfo = ()>,

pub fn max_date() -> Self

where C: CalendarArithmetic<YearInfo = ()>,

fn offset_days( &mut self, day_offset: i32, data: &impl PrecomputedDataSource<C::YearInfo>, )

fn offset_months( &mut self, month_offset: i32, data: &impl PrecomputedDataSource<C::YearInfo>, )

pub fn offset_date( &mut self, offset: DateDuration<C>, data: &impl PrecomputedDataSource<C::YearInfo>, )

pub fn until( &self, date2: ArithmeticDate<C>, _largest_unit: DateDurationUnit, _smaller_unit: DateDurationUnit, ) -> DateDuration<C>

pub fn days_in_year(&self) -> u16

pub fn months_in_year(&self) -> u8

pub fn days_in_month(&self) -> u8

pub fn day_of_year(&self) -> u16

pub fn date_from_year_day(year: i32, year_day: u32) -> ArithmeticDate<C>

where C: CalendarArithmetic<YearInfo = ()>,

pub fn day_of_month(&self) -> DayOfMonth

pub fn month(&self) -> FormattableMonth

The types::FormattableMonth for the current month (with month code) for a solar calendar Lunar calendars should not use this method and instead manually implement a month code resolver. Originally “solar_month” but renamed because it can be used for some lunar calendars

Returns “und” if run with months that are out of bounds for the current calendar.

pub fn new_from_codes<C2: Calendar>( cal: &C2, year: i32, month_code: MonthCode, day: u8, ) -> Result<Self, CalendarError>

where C: CalendarArithmetic<YearInfo = ()>,

Construct a new arithmetic date from a year, month code, and day, bounds checking the month and day Originally (new_from_solar_codes) but renamed because it works for some lunar calendars

pub fn new_from_ordinals( year: i32, month: u8, day: u8, ) -> Result<Self, CalendarError>

where C: CalendarArithmetic<YearInfo = ()>,

Construct a new arithmetic date from a year, month ordinal, and day, bounds checking the month and day Originally (new_from_solar_ordinals) but renamed because it works for some lunar calendars

pub fn new_from_ordinals_with_info( year: i32, month: u8, day: u8, info: C::YearInfo, ) -> Result<Self, CalendarError>

Construct a new arithmetic date from a year, month ordinal, and day, bounds checking the month and day

Trait Implementations

impl<C: CalendarArithmetic> Clone for ArithmeticDate<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + CalendarArithmetic> Debug for ArithmeticDate<C>

where C::YearInfo: Debug,

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

Formats the value using the given formatter.

impl<C: CalendarArithmetic> Hash for ArithmeticDate<C>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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<C: CalendarArithmetic> Ord for ArithmeticDate<C>

fn cmp(&self, other: &Self) -> 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<C: CalendarArithmetic> PartialEq for ArithmeticDate<C>

fn eq(&self, other: &Self) -> 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<C: CalendarArithmetic> PartialOrd for ArithmeticDate<C>

fn partial_cmp(&self, other: &Self) -> 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<C: CalendarArithmetic> Copy for ArithmeticDate<C>

impl<C: CalendarArithmetic> Eq for ArithmeticDate<C>