Struct icu_calendar::dangi::Dangi

pub struct Dangi {
    data: Option<DataPayload<DangiCacheV1Marker>>,
}

The Dangi Calendar

The Dangi Calendar is a lunisolar calendar used traditionally in North and South Korea. It is often used today to track important cultural events and holidays like Seollal (Korean lunar new year). It is similar to the Chinese lunar calendar (see Chinese), except that observations are based in Korea (currently UTC+9) rather than China (UTC+8). This can cause some differences; for example, 2012 was a leap year, but in the Dangi calendar the leap month was 3, while in the Chinese calendar the leap month was 4.

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

use icu::calendar::{chinese::Chinese, dangi::Dangi, Date};
use tinystr::tinystr;

let iso_a = Date::try_new_iso_date(2012, 4, 23).unwrap();
let dangi_a = iso_a.to_calendar(Dangi::new());
let chinese_a = iso_a.to_calendar(Chinese::new());

assert_eq!(dangi_a.month().code.0, tinystr!(4, "M03L"));
assert_eq!(chinese_a.month().code.0, tinystr!(4, "M04"));

let iso_b = Date::try_new_iso_date(2012, 5, 23).unwrap();
let dangi_b = iso_b.to_calendar(Dangi::new());
let chinese_b = iso_b.to_calendar(Chinese::new());

assert_eq!(dangi_b.month().code.0, tinystr!(4, "M04"));
assert_eq!(chinese_b.month().code.0, tinystr!(4, "M04L"));

Era codes

This Calendar supports a single era code “dangi” based on the year -2332 ISO (2333 BCE) as year 1. Typically years will be formatted using cyclic years and the related ISO year.

Month codes

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

Fields

data: Option<DataPayload<DangiCacheV1Marker>>

Implementations

impl Dangi

pub const fn new() -> Self

Creates a new Dangi with some precomputed calendrical calculations.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

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

pub fn try_new_unstable<D: DataProvider<DangiCacheV1Marker> + ?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.

pub fn new_always_calculating() -> Self

Construct a new Dangi without any precomputed calendrical calculations.

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

impl Dangi

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

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

Trait Implementations

impl Calendar for Dangi

type DateInner = DangiDateInner

The internal type used to represent dates

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

Construct a date from era/month codes and fields

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

Construct the date from an ISO date

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

Obtain an ISO date from this date

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

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

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

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

Obtain a name for the calendar for debug printing

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

The calendar-specific year represented by date

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

Calculate if a date is in a leap year

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

The calendar-specific month represented by date

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

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

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

Information of the day of the year

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

Calculate the day of the week and return it

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

The AnyCalendarKind corresponding to this calendar, if one exists. Implementors outside of icu::calendar should return None

impl ChineseBasedWithDataLoading for Dangi

type CB = Dangi

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.

impl Clone for Dangi

fn clone(&self) -> Dangi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dangi

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

Formats the value using the given formatter.

impl Default for Dangi

fn default() -> Dangi

Returns the “default value” for a type.

impl IntoAnyCalendar for Dangi

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn to_any_cloned(&self) -> AnyCalendar

Convert this calendar into an AnyCalendar, cloning it

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

Convert a date for this calendar into an AnyDateInner

impl Ord for Dangi

fn cmp(&self, _: &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 PartialEq for Dangi

fn eq(&self, _: &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 PartialOrd for Dangi

fn partial_cmp(&self, _: &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 Eq for Dangi