Enum icu::calendar::AnyCalendar

#[non_exhaustive]
pub enum AnyCalendar {
    Buddhist(Buddhist),
    Chinese(Chinese),
    Coptic(Coptic),
    Dangi(Dangi),
    Ethiopian(Ethiopian),
    Gregorian(Gregorian),
    Hebrew(Hebrew),
    Indian(Indian),
    IslamicCivil(IslamicCivil),
    IslamicObservational(IslamicObservational),
    IslamicTabular(IslamicTabular),
    IslamicUmmAlQura(IslamicUmmAlQura),
    Iso(Iso),
    Japanese(Japanese),
    JapaneseExtended(JapaneseExtended),
    Persian(Persian),
    Roc(Roc),
}

This is a calendar that encompasses all formattable calendars supported by this crate

This allows for the construction of Date objects that have their calendar known at runtime.

This can be constructed by calling .into() on a concrete calendar type if the calendar type is known at compile time. When the type is known at runtime, the AnyCalendar::new() and sibling methods may be used.

Date can also be converted to AnyCalendar-compatible ones via Date::to_any().

There are many ways of constructing an AnyCalendar’d date:

use icu::calendar::{AnyCalendar, DateTime, cal::Japanese, Time, types::{Era, MonthCode}};
use icu::locale::locale;
use tinystr::tinystr;

let locale = locale!("en-u-ca-japanese"); // English with the Japanese calendar

let calendar = AnyCalendar::new_for_locale(locale.into());
let calendar = Rc::new(calendar); // Avoid cloning it each time
                                  // If everything is a local reference, you may use icu::calendar::Ref instead.

// manually construct a datetime in this calendar
let manual_time = Time::try_new(12, 33, 12, 0).expect("failed to construct Time");
// construct from era code, year, month code, day, time, and a calendar
// This is March 28, 15 Heisei
let manual_datetime = DateTime::try_new_from_codes(Some(Era(tinystr!(16, "heisei"))), 15, MonthCode(tinystr!(4, "M03")), 28,
                                               manual_time, calendar.clone())
                    .expect("Failed to construct DateTime manually");


// construct another datetime by converting from ISO
let iso_datetime = DateTime::try_new_iso(2020, 9, 1, 12, 34, 28)
    .expect("Failed to construct ISO DateTime.");
let iso_converted = iso_datetime.to_calendar(calendar);

// Construct a datetime in the appropriate typed calendar and convert
let japanese_calendar = Japanese::new();
let japanese_datetime = DateTime::try_new_japanese_with_calendar(Era(tinystr!(16, "heisei")), 15, 3, 28,
                                                        12, 33, 12, japanese_calendar).unwrap();
// This is a DateTime<AnyCalendar>
let any_japanese_datetime = japanese_datetime.to_any();

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Buddhist(Buddhist)

A Buddhist calendar

Chinese(Chinese)

A Chinese calendar

Coptic(Coptic)

A Coptic calendar

Dangi(Dangi)

A Dangi calendar

Ethiopian(Ethiopian)

An Ethiopian calendar

Gregorian(Gregorian)

A Gregorian calendar

Hebrew(Hebrew)

A Hebrew calendar

Indian(Indian)

An Indian calendar

IslamicCivil(IslamicCivil)

An IslamicCivil calendar

IslamicObservational(IslamicObservational)

An IslamicObservational calendar

IslamicTabular(IslamicTabular)

An IslamicTabular calendar

IslamicUmmAlQura(IslamicUmmAlQura)

An IslamicUmmAlQura calendar

Iso(Iso)

An Iso calendar

Japanese(Japanese)

A Japanese calendar

JapaneseExtended(JapaneseExtended)

A JapaneseExtended calendar

Persian(Persian)

A Persian calendar

Roc(Roc)

A Roc calendar

Implementations

impl AnyCalendar

pub const fn new(kind: AnyCalendarKind) -> AnyCalendar

Constructs an AnyCalendar for a given calendar kind from compiled data.

As this requires a valid AnyCalendarKind to work, it does not do any kind of locale-based fallbacking. If this is desired, use Self::new_for_locale().

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_with_any_provider<P>( provider: &P, kind: AnyCalendarKind, ) -> Result<AnyCalendar, DataError>

where P: AnyProvider + ?Sized,

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

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider<P>( provider: &P, kind: AnyCalendarKind, ) -> Result<AnyCalendar, DataError>

where P: BufferProvider + ?Sized,

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_unstable<P>( provider: &P, kind: AnyCalendarKind, ) -> Result<AnyCalendar, DataError>

where P: DataProvider<JapaneseErasV1Marker> + DataProvider<JapaneseExtendedErasV1Marker> + DataProvider<ChineseCacheV1Marker> + DataProvider<DangiCacheV1Marker> + DataProvider<IslamicObservationalCacheV1Marker> + DataProvider<IslamicUmmAlQuraCacheV1Marker> + ?Sized,

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_for_locale(prefs: AnyCalendarPreferences) -> AnyCalendar

Constructs an AnyCalendar for a given calendar kind from compiled data.

In case the locale’s calendar is unknown or unspecified, it will attempt to load the default calendar for the locale, falling back to gregorian.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

pub fn try_new_for_locale_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: AnyCalendarPreferences, ) -> Result<AnyCalendar, DataError>

A version of [Self :: new_for_locale] that uses custom data provided by an AnyProvider.

📚 Help choosing a constructor

pub fn try_new_for_locale_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: AnyCalendarPreferences, ) -> Result<AnyCalendar, DataError>

A version of [Self :: new_for_locale] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

📚 Help choosing a constructor

pub fn try_new_for_locale_unstable<P>( provider: &P, prefs: AnyCalendarPreferences, ) -> Result<AnyCalendar, DataError>

where P: DataProvider<JapaneseErasV1Marker> + DataProvider<JapaneseExtendedErasV1Marker> + DataProvider<ChineseCacheV1Marker> + DataProvider<DangiCacheV1Marker> + DataProvider<IslamicObservationalCacheV1Marker> + DataProvider<IslamicUmmAlQuraCacheV1Marker> + ?Sized,

A version of Self::new_for_locale 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 kind(&self) -> AnyCalendarKind

The AnyCalendarKind corresponding to the calendar this contains

pub fn convert_any_date<'a>( &'a self, date: &Date<impl AsCalendar<Calendar = AnyCalendar>>, ) -> Date<Ref<'a, AnyCalendar>>

Given an AnyCalendar date, convert that date to another AnyCalendar date in this calendar, if conversion is needed

pub fn convert_any_datetime<'a>( &'a self, date: &DateTime<impl AsCalendar<Calendar = AnyCalendar>>, ) -> DateTime<Ref<'a, AnyCalendar>>

Given an AnyCalendar datetime, convert that date to another AnyCalendar datetime in this calendar, if conversion is needed

Trait Implementations

impl Calendar for AnyCalendar

fn is_in_leap_year(&self, date: &<AnyCalendar as Calendar>::DateInner) -> bool

The calendar-specific check if date is in a leap year

fn month(&self, date: &<AnyCalendar as Calendar>::DateInner) -> MonthInfo

The calendar-specific month represented by date

fn day_of_month( &self, date: &<AnyCalendar as Calendar>::DateInner, ) -> DayOfMonth

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

fn day_of_year_info( &self, date: &<AnyCalendar as Calendar>::DateInner, ) -> DayOfYearInfo

Information of the day of the year

type DateInner = AnyDateInner

The internal type used to represent dates

fn date_from_codes( &self, era: Option<Era>, year: i32, month_code: MonthCode, day: u8, ) -> Result<<AnyCalendar as Calendar>::DateInner, DateError>

Construct a date from era/month codes and fields

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

Construct the date from an ISO date

fn date_to_iso(&self, date: &<AnyCalendar as Calendar>::DateInner) -> Date<Iso>

Obtain an ISO date from this date

fn months_in_year(&self, date: &<AnyCalendar as Calendar>::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: &<AnyCalendar as Calendar>::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: &<AnyCalendar as Calendar>::DateInner) -> u8

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

fn year(&self, date: &<AnyCalendar as Calendar>::DateInner) -> YearInfo

Information about the year

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

Obtain a name for the calendar for debug printing

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

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

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

Calculate the day of the week and return it

impl Clone for AnyCalendar

fn clone(&self) -> AnyCalendar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnyCalendar

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

Formats the value using the given formatter.

impl From<Buddhist> for AnyCalendar

fn from(value: Buddhist) -> AnyCalendar

Converts to this type from the input type.

impl From<Chinese> for AnyCalendar

fn from(value: Chinese) -> AnyCalendar

Converts to this type from the input type.

impl From<Coptic> for AnyCalendar

fn from(value: Coptic) -> AnyCalendar

Converts to this type from the input type.

impl From<Dangi> for AnyCalendar

fn from(value: Dangi) -> AnyCalendar

Converts to this type from the input type.

impl From<Ethiopian> for AnyCalendar

fn from(value: Ethiopian) -> AnyCalendar

Converts to this type from the input type.

impl From<Gregorian> for AnyCalendar

fn from(value: Gregorian) -> AnyCalendar

Converts to this type from the input type.

impl From<Hebrew> for AnyCalendar

fn from(value: Hebrew) -> AnyCalendar

Converts to this type from the input type.

impl From<Indian> for AnyCalendar

fn from(value: Indian) -> AnyCalendar

Converts to this type from the input type.

impl From<IslamicCivil> for AnyCalendar

fn from(value: IslamicCivil) -> AnyCalendar

Converts to this type from the input type.

impl From<IslamicObservational> for AnyCalendar

fn from(value: IslamicObservational) -> AnyCalendar

Converts to this type from the input type.

impl From<IslamicTabular> for AnyCalendar

fn from(value: IslamicTabular) -> AnyCalendar

Converts to this type from the input type.

impl From<IslamicUmmAlQura> for AnyCalendar

fn from(value: IslamicUmmAlQura) -> AnyCalendar

Converts to this type from the input type.

impl From<Iso> for AnyCalendar

fn from(value: Iso) -> AnyCalendar

Converts to this type from the input type.

impl From<Japanese> for AnyCalendar

fn from(value: Japanese) -> AnyCalendar

Converts to this type from the input type.

impl From<JapaneseExtended> for AnyCalendar

fn from(value: JapaneseExtended) -> AnyCalendar

Converts to this type from the input type.

impl From<Persian> for AnyCalendar

fn from(value: Persian) -> AnyCalendar

Converts to this type from the input type.

impl From<Roc> for AnyCalendar

fn from(value: Roc) -> AnyCalendar

Converts to this type from the input type.

impl IntoAnyCalendar for AnyCalendar

fn to_any(self) -> AnyCalendar

Convert this calendar into an AnyCalendar, moving it

fn kind(&self) -> AnyCalendarKind

The AnyCalendarKind enum variant associated with this calendar

fn to_any_cloned(&self) -> AnyCalendar

Convert this calendar into an AnyCalendar, cloning it

fn from_any(any: AnyCalendar) -> Result<AnyCalendar, AnyCalendar>

Move an AnyCalendar into a Self, or returning it as an error if the types do not match.

fn from_any_ref(any: &AnyCalendar) -> Option<&AnyCalendar>

Convert an AnyCalendar reference into a Self reference.

fn date_to_any(&self, d: &<AnyCalendar as Calendar>::DateInner) -> AnyDateInner

Convert a date for this calendar into an AnyDateInner