Struct icu_calendar::chinese::Chinese

source ·
pub struct Chinese {
    data: Option<DataPayload<ChineseCacheV1Marker>>,
}
Expand description

The Chinese Calendar

The [Chinese Calendar] is a lunisolar calendar used traditionally in China as well as in other countries particularly in, but not limited to, East Asia. It is often used today to track important cultural events and holidays like the Chinese Lunar New Year.

This type can be used with Date or DateTime to represent dates in the Chinese calendar.

§Months

The Chinese calendar is an astronomical calendar which uses the phases of the moon to track months. Each month starts on the date of the new moon as observed from China, meaning that months last 29 or 30 days.

One year in the Chinese calendar is typically 12 lunar months; however, because 12 lunar months does not line up to one solar year, the Chinese calendar will add an intercalary leap month approximately every three years to keep Chinese calendar months in line with the solar year.

Leap months can happen after any month; the month in which a leap month occurs is based on the alignment of months with 24 solar terms into which the solar year is divided.

§Year and Era codes

Unlike the Gregorian calendar, the Chinese calendar does not traditionally count years in an infinitely increasing sequence. Instead, 10 “celestial stems” and 12 “terrestrial branches” are combined to form a cycle of year names which repeats every 60 years. However, for the purposes of calendar calculations and conversions, this module counts Chinese years in an infinite system similar to ISO, with year 1 in the calendar corresponding to the inception of the calendar, marked as 2637 BCE (ISO: -2636), and negative years marking Chinese years before February 15, 2637 BCE.

Because the Chinese calendar does not traditionally count years, era codes are not used in this calendar; this crate supports a single era code “chinese”.

This Chinese calendar implementation also supports a related ISO year, which marks the ISO year in which a Chinese year begins, and a cyclic year corresponding to the year in the 60 year cycle as described above.

For more information, suggested reading materials include:

§Month codes

This calendar is a lunisolar calendar. It supports regular month codes "M01" - "M12" as well as leap month codes "M01L" - "M12L".

This calendar is currently in a preview state: formatting for this calendar is not going to be perfect.

Fields§

§data: Option<DataPayload<ChineseCacheV1Marker>>

Implementations§

source§

impl Chinese

source

pub const fn new() -> Self

Creates a new Chinese with some precomputed calendrical calculations.

Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

source

pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), ) -> Result<Self, CalendarError>

A version of Self::new that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

source

pub fn try_new_unstable<D: DataProvider<ChineseCacheV1Marker> + ?Sized>( provider: &D, ) -> Result<Self, CalendarError>

A version of Self::new that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

⚠️ The bounds on provider may change over time, including in SemVer minor releases.
source

pub fn new_always_calculating() -> Self

Construct a new Chinese without any precomputed calendrical calculations.

source

pub(crate) const DEBUG_NAME: &'static str = "Chinese"

source§

impl Chinese

source

fn format_chinese_year( year: i32, year_info_option: Option<ChineseBasedYearInfo>, ) -> FormattableYear

Get a FormattableYear from an integer Chinese year; optionally, a ChineseBasedYearInfo can be passed in for faster results.

era is always Era(tinystr!(16, "chinese")) number is the year since the inception of the Chinese calendar (see Chinese) cyclic is an option with the current year in the sexagesimal cycle (see Chinese) related_iso is the ISO year in which the given Chinese year begins (see Chinese)

Trait Implementations§

source§

impl Calendar for Chinese

source§

fn debug_name(&self) -> &'static str

Obtain a name for the calendar for debug printing

source§

fn year(&self, date: &Self::DateInner) -> FormattableYear

The calendar-specific year represented by date

source§

fn month(&self, date: &Self::DateInner) -> FormattableMonth

The calendar-specific month code represented by date; since the Chinese calendar has leap months, an “L” is appended to the month code for leap months. For example, in a year where an intercalary month is added after the second month, the month codes for ordinal months 1, 2, 3, 4, 5 would be “M01”, “M02”, “M02L”, “M03”, “M04”.

source§

fn day_of_month(&self, date: &Self::DateInner) -> DayOfMonth

The calendar-specific day-of-month represented by date

source§

fn day_of_year_info(&self, date: &Self::DateInner) -> DayOfYearInfo

Information of the day of the year

source§

fn any_calendar_kind(&self) -> Option<AnyCalendarKind>

The AnyCalendarKind corresponding to this calendar

§

type DateInner = ChineseDateInner

The internal type used to represent dates
source§

fn date_from_codes( &self, era: Era, year: i32, month_code: MonthCode, day: u8, ) -> Result<Self::DateInner, CalendarError>

Construct a date from era/month codes and fields
source§

fn date_from_iso(&self, iso: Date<Iso>) -> Self::DateInner

Construct the date from an ISO date
source§

fn date_to_iso(&self, date: &Self::DateInner) -> Date<Iso>

Obtain an ISO date from this date
source§

fn days_in_year(&self, date: &Self::DateInner) -> u16

Count the number of days in a given year, specified by providing a date from that year
source§

fn days_in_month(&self, date: &Self::DateInner) -> u8

Count the number of days in a given month, specified by providing a date from that year/month
source§

fn is_in_leap_year(&self, date: &Self::DateInner) -> bool

Calculate if a date is in a leap year
source§

fn months_in_year(&self, date: &Self::DateInner) -> u8

Count the number of months in a given year, specified by providing a date from that year
source§

fn day_of_week(&self, date: &Self::DateInner) -> IsoWeekday

Calculate the day of the week and return it
source§

impl ChineseBasedWithDataLoading for Chinese

§

type CB = Chinese

source§

fn get_precomputed_data(&self) -> ChineseBasedPrecomputedData<'_, Self::CB>

Get the compiled const data for a ChineseBased calendar; can return None if the given year does not correspond to any compiled data.
source§

impl Clone for Chinese

source§

fn clone(&self) -> Chinese

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Chinese

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Chinese

source§

fn default() -> Chinese

Returns the “default value” for a type. Read more
source§

impl IntoAnyCalendar for Chinese

source§

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it Read more
source§

fn to_any_cloned(&self) -> AnyCalendar

Convert this calendar into an AnyCalendar, cloning it Read more
source§

fn date_to_any(&self, d: &Self::DateInner) -> AnyDateInner

Convert a date for this calendar into an AnyDateInner Read more
source§

impl Ord for Chinese

source§

fn cmp(&self, _: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Chinese

source§

fn eq(&self, _: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialOrd for Chinese

source§

fn partial_cmp(&self, _: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Chinese

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<C> AsCalendar for C
where C: Calendar,

§

type Calendar = C

The calendar being wrapped
source§

fn as_calendar(&self) -> &C

Obtain the inner calendar
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T