use crate::helpers::size_test;
#[cfg(feature = "experimental")]
use crate::provider::date_time::UnsupportedOptionsOrDataOrPatternError;
use crate::provider::{
calendar::*,
date_time::{PatternForLengthError, PatternSelector},
};
use crate::{calendar, options::DateTimeFormatterOptions, raw, DateFormatter, TimeFormatter};
use crate::{input::DateTimeInput, DateTimeError, FormattedDateTime};
use alloc::string::String;
use icu_calendar::any_calendar::AnyCalendar;
use icu_calendar::provider::{
ChineseCacheV1Marker, DangiCacheV1Marker, IslamicObservationalCacheV1Marker,
IslamicUmmAlQuraCacheV1Marker, JapaneseErasV1Marker, JapaneseExtendedErasV1Marker,
WeekDataV1Marker,
};
use icu_decimal::provider::DecimalSymbolsV1Marker;
use icu_plurals::provider::OrdinalV1Marker;
use icu_provider::prelude::*;
use icu_provider::DataLocale;
use writeable::Writeable;
size_test!(DateTimeFormatter, date_time_formatter_size, 5208);
#[doc = date_time_formatter_size!()]
#[derive(Debug)]
pub struct DateTimeFormatter(pub(crate) raw::DateTimeFormatter, AnyCalendar);
impl DateTimeFormatter {
#[cfg(feature = "compiled_data")]
#[inline]
pub fn try_new(
locale: &DataLocale,
options: DateTimeFormatterOptions,
) -> Result<Self, DateTimeError> {
let calendar = AnyCalendar::new_for_locale(locale);
let kind = calendar.kind();
let patterns = PatternSelector::for_options(
&crate::provider::Baked,
calendar::load_lengths_for_any_calendar_kind(&crate::provider::Baked, locale, kind)?,
locale,
&options,
)
.map_err(|e| match e {
PatternForLengthError::Data(e) => DateTimeError::Data(e),
PatternForLengthError::Pattern(e) => DateTimeError::Pattern(e),
})?;
Ok(Self(
raw::DateTimeFormatter::try_new(
patterns,
|| {
calendar::load_symbols_for_any_calendar_kind(
&crate::provider::Baked,
locale,
kind,
)
},
locale,
)?,
calendar,
))
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(ANY, Self::try_new)]
#[inline]
pub fn try_new_with_any_provider(
provider: &impl AnyProvider,
locale: &DataLocale,
options: DateTimeFormatterOptions,
) -> Result<Self, DateTimeError> {
let downcasting = provider.as_downcasting();
Self::try_new_unstable(&downcasting, locale, options)
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(BUFFER, Self::try_new)]
#[inline]
#[cfg(feature = "serde")]
pub fn try_new_with_buffer_provider(
provider: &impl BufferProvider,
locale: &DataLocale,
options: DateTimeFormatterOptions,
) -> Result<Self, DateTimeError> {
let deserializing = provider.as_deserializing();
Self::try_new_unstable(&deserializing, locale, options)
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new_experimental)]
#[cfg(feature = "experimental")]
#[inline(never)]
pub fn try_new_experimental_unstable<P>(
provider: &P,
locale: &DataLocale,
options: DateTimeFormatterOptions,
) -> Result<Self, DateTimeError>
where
P: DataProvider<TimeSymbolsV1Marker>
+ DataProvider<TimeLengthsV1Marker>
+ DataProvider<crate::provider::calendar::DateSkeletonPatternsV1Marker>
+ DataProvider<OrdinalV1Marker>
+ DataProvider<WeekDataV1Marker>
+ DataProvider<DecimalSymbolsV1Marker>
+ DataProvider<BuddhistDateLengthsV1Marker>
+ DataProvider<BuddhistDateSymbolsV1Marker>
+ DataProvider<ChineseCacheV1Marker>
+ DataProvider<ChineseDateLengthsV1Marker>
+ DataProvider<ChineseDateSymbolsV1Marker>
+ DataProvider<CopticDateLengthsV1Marker>
+ DataProvider<CopticDateSymbolsV1Marker>
+ DataProvider<DangiCacheV1Marker>
+ DataProvider<DangiDateLengthsV1Marker>
+ DataProvider<DangiDateSymbolsV1Marker>
+ DataProvider<EthiopianDateLengthsV1Marker>
+ DataProvider<EthiopianDateSymbolsV1Marker>
+ DataProvider<GregorianDateLengthsV1Marker>
+ DataProvider<GregorianDateSymbolsV1Marker>
+ DataProvider<HebrewDateLengthsV1Marker>
+ DataProvider<HebrewDateSymbolsV1Marker>
+ DataProvider<IndianDateLengthsV1Marker>
+ DataProvider<IndianDateSymbolsV1Marker>
+ DataProvider<IslamicDateLengthsV1Marker>
+ DataProvider<IslamicDateSymbolsV1Marker>
+ DataProvider<IslamicObservationalCacheV1Marker>
+ DataProvider<IslamicUmmAlQuraCacheV1Marker>
+ DataProvider<JapaneseDateLengthsV1Marker>
+ DataProvider<JapaneseDateSymbolsV1Marker>
+ DataProvider<JapaneseErasV1Marker>
+ DataProvider<JapaneseExtendedDateLengthsV1Marker>
+ DataProvider<JapaneseExtendedDateSymbolsV1Marker>
+ DataProvider<JapaneseExtendedErasV1Marker>
+ DataProvider<PersianDateLengthsV1Marker>
+ DataProvider<PersianDateSymbolsV1Marker>
+ DataProvider<RocDateLengthsV1Marker>
+ DataProvider<RocDateSymbolsV1Marker>
+ ?Sized,
{
let calendar = AnyCalendar::try_new_for_locale_unstable(provider, locale)?;
let kind = calendar.kind();
let patterns = PatternSelector::for_options_experimental(
provider,
calendar::load_lengths_for_any_calendar_kind(provider, locale, kind)?,
locale,
&kind.as_bcp47_value(),
&options,
)
.map_err(|e| match e {
UnsupportedOptionsOrDataOrPatternError::UnsupportedOptions => {
DateTimeError::UnsupportedOptions
}
UnsupportedOptionsOrDataOrPatternError::Data(e) => DateTimeError::Data(e),
UnsupportedOptionsOrDataOrPatternError::Pattern(e) => DateTimeError::Pattern(e),
})?;
Ok(Self(
raw::DateTimeFormatter::try_new_unstable(
provider,
patterns,
|| calendar::load_symbols_for_any_calendar_kind(provider, locale, kind),
locale,
)?,
calendar,
))
}
#[cfg(feature = "experimental")]
#[cfg(feature = "compiled_data")]
#[inline(never)]
pub fn try_new_experimental(
locale: &DataLocale,
options: DateTimeFormatterOptions,
) -> Result<Self, DateTimeError> {
let calendar = AnyCalendar::new_for_locale(locale);
let kind = calendar.kind();
let patterns = PatternSelector::for_options_experimental(
&crate::provider::Baked,
calendar::load_lengths_for_any_calendar_kind(&crate::provider::Baked, locale, kind)?,
locale,
&kind.as_bcp47_value(),
&options,
)
.map_err(|e| match e {
UnsupportedOptionsOrDataOrPatternError::UnsupportedOptions => {
DateTimeError::UnsupportedOptions
}
UnsupportedOptionsOrDataOrPatternError::Data(e) => DateTimeError::Data(e),
UnsupportedOptionsOrDataOrPatternError::Pattern(e) => DateTimeError::Pattern(e),
})?;
Ok(Self(
raw::DateTimeFormatter::try_new(
patterns,
|| {
calendar::load_symbols_for_any_calendar_kind(
&crate::provider::Baked,
locale,
kind,
)
},
locale,
)?,
calendar,
))
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
#[inline(never)]
pub fn try_new_unstable<P>(
provider: &P,
locale: &DataLocale,
options: DateTimeFormatterOptions,
) -> Result<Self, DateTimeError>
where
P: DataProvider<TimeSymbolsV1Marker>
+ DataProvider<TimeLengthsV1Marker>
+ DataProvider<OrdinalV1Marker>
+ DataProvider<WeekDataV1Marker>
+ DataProvider<DecimalSymbolsV1Marker>
+ DataProvider<BuddhistDateLengthsV1Marker>
+ DataProvider<BuddhistDateSymbolsV1Marker>
+ DataProvider<ChineseCacheV1Marker>
+ DataProvider<ChineseDateLengthsV1Marker>
+ DataProvider<ChineseDateSymbolsV1Marker>
+ DataProvider<CopticDateLengthsV1Marker>
+ DataProvider<CopticDateSymbolsV1Marker>
+ DataProvider<DangiCacheV1Marker>
+ DataProvider<DangiDateLengthsV1Marker>
+ DataProvider<DangiDateSymbolsV1Marker>
+ DataProvider<EthiopianDateLengthsV1Marker>
+ DataProvider<EthiopianDateSymbolsV1Marker>
+ DataProvider<GregorianDateLengthsV1Marker>
+ DataProvider<GregorianDateSymbolsV1Marker>
+ DataProvider<HebrewDateLengthsV1Marker>
+ DataProvider<HebrewDateSymbolsV1Marker>
+ DataProvider<IndianDateLengthsV1Marker>
+ DataProvider<IndianDateSymbolsV1Marker>
+ DataProvider<IslamicDateLengthsV1Marker>
+ DataProvider<IslamicDateSymbolsV1Marker>
+ DataProvider<JapaneseDateLengthsV1Marker>
+ DataProvider<JapaneseDateSymbolsV1Marker>
+ DataProvider<JapaneseErasV1Marker>
+ DataProvider<JapaneseExtendedDateLengthsV1Marker>
+ DataProvider<JapaneseExtendedDateSymbolsV1Marker>
+ DataProvider<JapaneseExtendedErasV1Marker>
+ DataProvider<IslamicObservationalCacheV1Marker>
+ DataProvider<IslamicUmmAlQuraCacheV1Marker>
+ DataProvider<PersianDateLengthsV1Marker>
+ DataProvider<PersianDateSymbolsV1Marker>
+ DataProvider<RocDateLengthsV1Marker>
+ DataProvider<RocDateSymbolsV1Marker>
+ ?Sized,
{
let calendar = AnyCalendar::try_new_for_locale_unstable(provider, locale)?;
let kind = calendar.kind();
let patterns = PatternSelector::for_options(
provider,
calendar::load_lengths_for_any_calendar_kind(provider, locale, kind)?,
locale,
&options,
)
.map_err(|e| match e {
PatternForLengthError::Data(e) => DateTimeError::Data(e),
PatternForLengthError::Pattern(e) => DateTimeError::Pattern(e),
})?;
Ok(Self(
raw::DateTimeFormatter::try_new_unstable(
provider,
patterns,
|| calendar::load_symbols_for_any_calendar_kind(provider, locale, kind),
locale,
)?,
calendar,
))
}
#[inline]
pub fn try_from_date_and_time(
date: DateFormatter,
time: TimeFormatter,
) -> Result<Self, DateTimeError>
where {
Ok(Self(
raw::DateTimeFormatter::try_from_date_and_time(date.0, time.0)?,
date.1,
))
}
#[inline]
pub fn format<'l, T>(&'l self, value: &T) -> Result<FormattedDateTime<'l>, DateTimeError>
where
T: DateTimeInput<Calendar = AnyCalendar>,
{
if let Some(converted) = calendar::convert_datetime_if_necessary(&self.1, value)? {
Ok(self.0.format(&converted))
} else {
Ok(self.0.format(value))
}
}
#[inline]
pub fn format_to_string(
&self,
value: &impl DateTimeInput<Calendar = AnyCalendar>,
) -> Result<String, DateTimeError> {
Ok(self.format(value)?.write_to_string().into_owned())
}
#[cfg(feature = "experimental")]
pub fn resolve_components(&self) -> crate::options::components::Bag {
self.0.resolve_components()
}
}
#[cfg(test)]
#[cfg(feature = "compiled_data")]
mod tests {
use icu::calendar::{AnyCalendar, DateTime};
use icu::datetime::{options::length, DateTimeFormatter};
use icu::locid::locale;
use icu_provider::DataLocale;
fn test_format(datetime: &DateTime<AnyCalendar>, locale: DataLocale, expected: &str) {
let options = length::Bag::from_date_time_style(length::Date::Long, length::Time::Short);
let dtf = DateTimeFormatter::try_new(&locale, options.into()).unwrap();
writeable::assert_writeable_eq!(
dtf.format(datetime).expect("Calendars should match"),
expected
);
}
#[test]
fn test_fallback() {
let datetime = DateTime::try_new_iso_datetime(2022, 4, 5, 12, 33, 44).unwrap();
let datetime = datetime.to_any();
test_format(&datetime, locale!("fr").into(), "5 avril 2022, 12:33");
test_format(
&datetime,
locale!("fr-u-ca-blahblah").into(),
"5 avril 2022, 12:33",
);
test_format(
&datetime,
locale!("th-u-ca-buddhist").into(),
"5 เมษายน 2565 12:33",
);
test_format(&datetime, locale!("th").into(), "5 เมษายน 2565 12:33");
test_format(
&datetime,
locale!("th-u-ca-gregory").into(),
"5 เมษายน ค.ศ. 2022 12:33",
);
}
#[test]
#[cfg(feature = "serde")]
fn works_with_default_options() {
assert_eq!(
DateTimeFormatter::try_new(Default::default(), Default::default(),)
.unwrap()
.format_to_string(
&DateTime::try_new_iso_datetime(2022, 9, 20, 0, 0, 0)
.unwrap()
.to_any()
)
.unwrap(),
"2022 M09 20 00:00:00"
);
}
}
#[test]
#[cfg(feature = "serde")]
fn buffer_constructor() {
use icu::calendar::DateTime;
use icu::datetime::{options::length, DateTimeFormatter};
use icu::locid::locale;
use writeable::assert_writeable_eq;
let provider = icu_provider_blob::BlobDataProvider::try_new_from_static_blob(include_bytes!(
"../../tests/data/blob.postcard"
))
.unwrap();
let dtf = DateTimeFormatter::try_new_with_buffer_provider(
&provider,
&locale!("en").into(),
length::Bag::from_date_time_style(length::Date::Medium, length::Time::Short).into(),
)
.unwrap();
assert_writeable_eq!(
dtf.format(
&DateTime::try_new_iso_datetime(2020, 9, 1, 12, 34, 28)
.unwrap()
.to_any()
)
.expect("Calendars should match"),
"Sep 1, 2020, 12:34 PM"
);
}