Enum icu_calendar::any_calendar::AnyCalendar
source · #[non_exhaustive]
pub enum AnyCalendar {
Gregorian(Gregorian),
Buddhist(Buddhist),
Japanese(Japanese),
JapaneseExtended(JapaneseExtended),
Ethiopian(Ethiopian),
Indian(Indian),
Coptic(Coptic),
Iso(Iso),
}
Expand description
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::try_new_with_any_provider()
,
AnyCalendar::try_new_with_buffer_provider()
, and AnyCalendar::try_new_unstable()
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, AnyCalendarKind, DateTime, japanese::Japanese, types::Time};
use icu::locid::locale;
let locale = locale!("en-u-ca-japanese"); // English with the Japanese calendar
let calendar = AnyCalendar::try_new_for_locale_unstable(&icu_testdata::unstable(), &locale.into())
.expect("constructing AnyCalendar failed");
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("heisei".parse().unwrap(), 15, "M03".parse().unwrap(), 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_datetime(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::try_new_unstable(&icu_testdata::unstable()).unwrap();
let japanese_datetime = DateTime::try_new_japanese_datetime("heisei".parse().unwrap(), 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)§
This enum is marked as non-exhaustive
Gregorian(Gregorian)
A Gregorian
calendar
Buddhist(Buddhist)
A Buddhist
calendar
Japanese(Japanese)
A Japanese
calendar
JapaneseExtended(JapaneseExtended)
A JapaneseExtended
calendar
Ethiopian(Ethiopian)
An Ethiopian
calendar
Indian(Indian)
An Indian
calendar
Coptic(Coptic)
A Coptic
calendar
Iso(Iso)
An Iso
calendar
Implementations§
source§impl AnyCalendar
impl AnyCalendar
sourcepub fn try_new_with_any_provider<P>(
provider: &P,
kind: AnyCalendarKind
) -> Result<Self, CalendarError>where
P: AnyProvider + ?Sized,
pub fn try_new_with_any_provider<P>( provider: &P, kind: AnyCalendarKind ) -> Result<Self, CalendarError>where P: AnyProvider + ?Sized,
Constructs an AnyCalendar for a given calendar kind and AnyProvider
data source
As this requires a valid AnyCalendarKind
to work, it does not do any kind of locale-based
fallbacking. If this is desired, use Self::try_new_for_locale_with_any_provider()
.
For calendars that need data, will attempt to load the appropriate data from the source.
This API needs the calendar/japanese@1
or calendar/japanext@1
data key if working with Japanese calendars.
sourcepub fn try_new_with_buffer_provider<P>(
provider: &P,
kind: AnyCalendarKind
) -> Result<Self, CalendarError>where
P: BufferProvider + ?Sized,
pub fn try_new_with_buffer_provider<P>( provider: &P, kind: AnyCalendarKind ) -> Result<Self, CalendarError>where P: BufferProvider + ?Sized,
Constructs an AnyCalendar for a given calendar kind and BufferProvider
data source
As this requires a valid AnyCalendarKind
to work, it does not do any kind of locale-based
fallbacking. If this is desired, use Self::try_new_for_locale_with_buffer_provider()
.
For calendars that need data, will attempt to load the appropriate data from the source.
This API needs the calendar/japanese@1
or calendar/japanext@1
data key if working with Japanese calendars.
This needs the "serde"
Cargo feature to be enabled to be used
sourcepub fn try_new_unstable<P>(
provider: &P,
kind: AnyCalendarKind
) -> Result<Self, CalendarError>where
P: DataProvider<JapaneseErasV1Marker> + DataProvider<JapaneseExtendedErasV1Marker> + ?Sized,
pub fn try_new_unstable<P>( provider: &P, kind: AnyCalendarKind ) -> Result<Self, CalendarError>where P: DataProvider<JapaneseErasV1Marker> + DataProvider<JapaneseExtendedErasV1Marker> + ?Sized,
Constructs an AnyCalendar for a given calendar kind and data source.
This method is unstable; the bounds on P
might expand over time as more calendars are added
As this requires a valid AnyCalendarKind
to work, it does not do any kind of locale-based
fallbacking. If this is desired, use Self::try_new_for_locale_unstable()
.
For calendars that need data, will attempt to load the appropriate data from the source
sourcepub fn try_new_for_locale_with_any_provider(
provider: &impl AnyProvider + ?Sized,
locale: &DataLocale
) -> Result<Self, CalendarError>
pub fn try_new_for_locale_with_any_provider( provider: &impl AnyProvider + ?Sized, locale: &DataLocale ) -> Result<Self, CalendarError>
Creates a new instance using an AnyProvider
.
For details on the behavior of this function, see: Self::try_new_for_locale_unstable
sourcepub fn try_new_for_locale_with_buffer_provider(
provider: &impl BufferProvider + ?Sized,
locale: &DataLocale
) -> Result<Self, CalendarError>
pub fn try_new_for_locale_with_buffer_provider( provider: &impl BufferProvider + ?Sized, locale: &DataLocale ) -> Result<Self, CalendarError>
✨ Enabled with the "serde"
feature.
Creates a new instance using a BufferProvider
.
For details on the behavior of this function, see: Self::try_new_for_locale_unstable
sourcepub fn try_new_for_locale_unstable<P>(
provider: &P,
locale: &DataLocale
) -> Result<Self, CalendarError>where
P: DataProvider<JapaneseErasV1Marker> + DataProvider<JapaneseExtendedErasV1Marker> + ?Sized,
pub fn try_new_for_locale_unstable<P>( provider: &P, locale: &DataLocale ) -> Result<Self, CalendarError>where P: DataProvider<JapaneseErasV1Marker> + DataProvider<JapaneseExtendedErasV1Marker> + ?Sized,
Constructs an AnyCalendar for a given calendar kind and data source.
This method is unstable; the bounds on P
might expand over time as more calendars are added
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.
For calendars that need data, will attempt to load the appropriate data from the source
sourcepub fn kind(&self) -> AnyCalendarKind
pub fn kind(&self) -> AnyCalendarKind
The AnyCalendarKind
corresponding to the calendar this contains
sourcepub fn convert_any_date<'a>(
&'a self,
date: &Date<impl AsCalendar<Calendar = AnyCalendar>>
) -> Date<Ref<'a, AnyCalendar>>
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
sourcepub fn convert_any_datetime<'a>(
&'a self,
date: &DateTime<impl AsCalendar<Calendar = AnyCalendar>>
) -> DateTime<Ref<'a, AnyCalendar>>
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§
source§impl Calendar for AnyCalendar
impl Calendar for AnyCalendar
source§fn year(&self, date: &Self::DateInner) -> FormattableYear
fn year(&self, date: &Self::DateInner) -> FormattableYear
The calendar-specific year represented by date
source§fn month(&self, date: &Self::DateInner) -> FormattableMonth
fn month(&self, date: &Self::DateInner) -> FormattableMonth
The calendar-specific month represented by date
source§fn day_of_month(&self, date: &Self::DateInner) -> DayOfMonth
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
fn day_of_year_info(&self, date: &Self::DateInner) -> DayOfYearInfo
Information of the day of the year
§type DateInner = AnyDateInner
type DateInner = AnyDateInner
source§fn date_from_codes(
&self,
era: Era,
year: i32,
month_code: MonthCode,
day: u8
) -> Result<Self::DateInner, CalendarError>
fn date_from_codes( &self, era: Era, year: i32, month_code: MonthCode, day: u8 ) -> Result<Self::DateInner, CalendarError>
source§fn date_from_iso(&self, iso: Date<Iso>) -> AnyDateInner
fn date_from_iso(&self, iso: Date<Iso>) -> AnyDateInner
source§fn months_in_year(&self, date: &Self::DateInner) -> u8
fn months_in_year(&self, date: &Self::DateInner) -> u8
source§fn days_in_year(&self, date: &Self::DateInner) -> u32
fn days_in_year(&self, date: &Self::DateInner) -> u32
source§fn days_in_month(&self, date: &Self::DateInner) -> u8
fn days_in_month(&self, date: &Self::DateInner) -> u8
source§fn debug_name(&self) -> &'static str
fn debug_name(&self) -> &'static str
source§fn any_calendar_kind(&self) -> Option<AnyCalendarKind>
fn any_calendar_kind(&self) -> Option<AnyCalendarKind>
AnyCalendarKind
corresponding to this calendar,
if one exists. Implementors outside of icu_calendar should return None