1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
use alloc::string::String;
use core::marker::PhantomData;
use icu_calendar::provider::WeekDataV1Marker;
use icu_decimal::provider::DecimalSymbolsV1Marker;
use icu_plurals::provider::OrdinalV1Marker;
use icu_provider::prelude::*;
use writeable::Writeable;
use crate::provider::date_time::PatternForLengthError;
#[cfg(feature = "experimental")]
use crate::provider::date_time::UnsupportedOptionsOrDataOrPatternError;
use crate::{
calendar,
calendar::CldrCalendar,
format::zoned_datetime::FormattedZonedDateTime,
input::{DateTimeInput, TimeZoneInput},
options::DateTimeFormatterOptions,
provider::{
self,
calendar::{TimeLengthsV1Marker, TimeSymbolsV1Marker},
date_time::PatternSelector,
},
raw,
time_zone::TimeZoneFormatterOptions,
DateTimeError,
};
/// The composition of [`TypedDateTimeFormatter`](crate::TypedDateTimeFormatter) and [`TimeZoneFormatter`].
///
/// [`TypedZonedDateTimeFormatter`] is a formatter capable of formatting
/// date/times with time zones from a calendar selected at compile time. For the difference between this
/// and [`DateTimeFormatter`](crate::DateTimeFormatter), please read the [crate root docs][crate].
///
/// [`TypedZonedDateTimeFormatter`] uses data from the [data provider]s, the selected locale, and the
/// provided pattern to collect all data necessary to format a datetime with time zones into that locale.
///
/// The various pattern symbols specified in UTS-35 require different sets of data for formatting.
/// As such, [`TimeZoneFormatter`] will pull in only the resources it needs to format that pattern
/// that is derived from the provided [`DateTimeFormatterOptions`].
///
/// For that reason, one should think of the process of formatting a zoned datetime in two steps:
/// first, a computationally heavy construction of [`TypedZonedDateTimeFormatter`], and then fast formatting
/// of the data using the instance.
///
/// # Examples
///
/// ```
/// use icu::calendar::{DateTime, Gregorian};
/// use icu::datetime::time_zone::TimeZoneFormatterOptions;
/// use icu::datetime::{options::length, TypedZonedDateTimeFormatter};
/// use icu::locid::locale;
/// use icu::timezone::CustomTimeZone;
/// use std::str::FromStr;
/// use writeable::assert_writeable_eq;
///
/// let options = length::Bag::from_date_time_style(
/// length::Date::Medium,
/// length::Time::Long,
/// );
/// let zdtf = TypedZonedDateTimeFormatter::<Gregorian>::try_new(
/// &locale!("en").into(),
/// options.into(),
/// TimeZoneFormatterOptions::default(),
/// )
/// .expect("Failed to create TypedDateTimeFormatter instance.");
///
/// let datetime =
/// DateTime::try_new_gregorian_datetime(2020, 9, 12, 12, 34, 28).unwrap();
/// let time_zone = CustomTimeZone::from_str("-07:00").unwrap();
///
/// let formatted_date = zdtf.format(&datetime, &time_zone);
///
/// assert_writeable_eq!(formatted_date, "Sep 12, 2020, 12:34:28 PM GMT-07:00");
/// ```
///
/// [`TimeZoneFormatter`]: crate::time_zone::TimeZoneFormatter
#[derive(Debug)]
pub struct TypedZonedDateTimeFormatter<C>(raw::ZonedDateTimeFormatter, PhantomData<C>);
impl<C: CldrCalendar> TypedZonedDateTimeFormatter<C> {
/// Constructor that takes a selected locale and a list of [`DateTimeFormatterOptions`].
/// It collects all data necessary to format zoned datetime values into the given locale.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
/// use icu::calendar::{DateTime, Gregorian};
/// use icu::datetime::time_zone::TimeZoneFormatterOptions;
/// use icu::datetime::{options::length, TypedZonedDateTimeFormatter};
/// use icu::locid::locale;
/// use icu::timezone::CustomTimeZone;
/// use writeable::assert_writeable_eq;
///
/// let options = length::Bag::from_date_time_style(
/// length::Date::Medium,
/// length::Time::Long,
/// );
///
/// let zdtf = TypedZonedDateTimeFormatter::<Gregorian>::try_new(
/// &locale!("en").into(),
/// options.into(),
/// TimeZoneFormatterOptions::default(),
/// )
/// .unwrap();
///
/// let datetime =
/// DateTime::try_new_gregorian_datetime(2022, 8, 31, 1, 2, 3).unwrap();
///
/// assert_writeable_eq!(
/// zdtf.format(&datetime, &CustomTimeZone::utc()),
/// "Aug 31, 2022, 1:02:03 AM GMT",
/// );
/// ```
///
/// [data provider]: icu_provider
#[inline]
#[cfg(feature = "compiled_data")]
pub fn try_new(
locale: &DataLocale,
date_time_format_options: DateTimeFormatterOptions,
time_zone_format_options: TimeZoneFormatterOptions,
) -> Result<Self, DateTimeError>
where
crate::provider::Baked:
DataProvider<C::DateLengthsV1Marker> + DataProvider<C::DateSymbolsV1Marker>,
{
let patterns = PatternSelector::for_options(
&crate::provider::Baked,
calendar::load_lengths_for_cldr_calendar::<C, _>(&crate::provider::Baked, locale)?,
locale,
&date_time_format_options,
)
.map_err(|e| match e {
PatternForLengthError::Data(e) => DateTimeError::Data(e),
PatternForLengthError::Pattern(e) => DateTimeError::Pattern(e),
})?;
Ok(Self(
raw::ZonedDateTimeFormatter::try_new(
patterns,
|| {
calendar::load_symbols_for_cldr_calendar::<C, _>(
&crate::provider::Baked,
locale,
)
},
locale,
time_zone_format_options,
)?,
PhantomData,
))
}
icu_provider::gen_any_buffer_data_constructors!(
locale: include,
date_time_format_options: DateTimeFormatterOptions,
time_zone_format_options: TimeZoneFormatterOptions,
error: DateTimeError,
#[cfg(skip)]
);
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
#[inline]
pub fn try_new_unstable<P>(
provider: &P,
locale: &DataLocale,
date_time_format_options: DateTimeFormatterOptions,
time_zone_format_options: TimeZoneFormatterOptions,
) -> Result<Self, DateTimeError>
where
P: DataProvider<<C as CldrCalendar>::DateSymbolsV1Marker>
+ DataProvider<<C as CldrCalendar>::DateLengthsV1Marker>
+ DataProvider<TimeSymbolsV1Marker>
+ DataProvider<TimeLengthsV1Marker>
+ DataProvider<WeekDataV1Marker>
+ DataProvider<provider::time_zones::TimeZoneFormatsV1Marker>
+ DataProvider<provider::time_zones::ExemplarCitiesV1Marker>
+ DataProvider<provider::time_zones::MetazoneGenericNamesLongV1Marker>
+ DataProvider<provider::time_zones::MetazoneGenericNamesShortV1Marker>
+ DataProvider<provider::time_zones::MetazoneSpecificNamesLongV1Marker>
+ DataProvider<provider::time_zones::MetazoneSpecificNamesShortV1Marker>
+ DataProvider<OrdinalV1Marker>
+ DataProvider<DecimalSymbolsV1Marker>
+ ?Sized,
{
let patterns = PatternSelector::for_options(
provider,
calendar::load_lengths_for_cldr_calendar::<C, _>(provider, locale)?,
locale,
&date_time_format_options,
)
.map_err(|e| match e {
PatternForLengthError::Data(e) => DateTimeError::Data(e),
PatternForLengthError::Pattern(e) => DateTimeError::Pattern(e),
})?;
Ok(Self(
raw::ZonedDateTimeFormatter::try_new_unstable(
provider,
patterns,
|| calendar::load_symbols_for_cldr_calendar::<C, _>(provider, locale),
locale,
time_zone_format_options,
)?,
PhantomData,
))
}
/// Constructor that takes a selected locale and a list of [`DateTimeFormatterOptions`].
/// It collects all data necessary to format zoned datetime values into the given locale.
///
/// ✨ *Enabled with the `compiled_data` and `experimental` Cargo features.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
///
/// # Examples
///
/// ```
/// use icu::calendar::{DateTime, Gregorian};
/// use icu::datetime::time_zone::TimeZoneFormatterOptions;
/// use icu::datetime::{options::components, TypedZonedDateTimeFormatter};
/// use icu::locid::locale;
/// use icu::timezone::CustomTimeZone;
/// use writeable::assert_writeable_eq;
///
/// let mut options = components::Bag::default();
/// options.year = Some(components::Year::Numeric);
/// options.month = Some(components::Month::Long);
/// options.hour = Some(components::Numeric::Numeric);
/// options.minute = Some(components::Numeric::Numeric);
/// options.time_zone_name = Some(components::TimeZoneName::GmtOffset);
///
/// let zdtf = TypedZonedDateTimeFormatter::<Gregorian>::try_new_experimental(
/// &locale!("en").into(),
/// options.into(),
/// TimeZoneFormatterOptions::default(),
/// )
/// .unwrap();
///
/// let datetime =
/// DateTime::try_new_gregorian_datetime(2022, 8, 31, 1, 2, 3).unwrap();
///
/// assert_writeable_eq!(
/// zdtf.format(&datetime, &CustomTimeZone::utc()),
/// "August 2022, 01:02 GMT",
/// );
/// ```
///
/// [data provider]: icu_provider
#[cfg(feature = "experimental")]
#[cfg(feature = "compiled_data")]
#[inline]
pub fn try_new_experimental(
locale: &DataLocale,
date_time_format_options: DateTimeFormatterOptions,
time_zone_format_options: TimeZoneFormatterOptions,
) -> Result<Self, DateTimeError>
where
crate::provider::Baked:
DataProvider<C::DateLengthsV1Marker> + DataProvider<C::DateSymbolsV1Marker>,
{
let patterns = PatternSelector::for_options_experimental(
&crate::provider::Baked,
calendar::load_lengths_for_cldr_calendar::<C, _>(&crate::provider::Baked, locale)?,
locale,
&C::DEFAULT_BCP_47_IDENTIFIER,
&date_time_format_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::ZonedDateTimeFormatter::try_new(
patterns,
|| {
calendar::load_symbols_for_cldr_calendar::<C, _>(
&crate::provider::Baked,
locale,
)
},
locale,
time_zone_format_options,
)?,
PhantomData,
))
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new_experimental)]
#[cfg(feature = "experimental")]
#[inline]
pub fn try_new_experimental_unstable<P>(
provider: &P,
locale: &DataLocale,
date_time_format_options: DateTimeFormatterOptions,
time_zone_format_options: TimeZoneFormatterOptions,
) -> Result<Self, DateTimeError>
where
P: DataProvider<<C as CldrCalendar>::DateSymbolsV1Marker>
+ DataProvider<<C as CldrCalendar>::DateLengthsV1Marker>
+ DataProvider<TimeSymbolsV1Marker>
+ DataProvider<TimeLengthsV1Marker>
+ DataProvider<crate::provider::calendar::DateSkeletonPatternsV1Marker>
+ DataProvider<WeekDataV1Marker>
+ DataProvider<provider::time_zones::TimeZoneFormatsV1Marker>
+ DataProvider<provider::time_zones::ExemplarCitiesV1Marker>
+ DataProvider<provider::time_zones::MetazoneGenericNamesLongV1Marker>
+ DataProvider<provider::time_zones::MetazoneGenericNamesShortV1Marker>
+ DataProvider<provider::time_zones::MetazoneSpecificNamesLongV1Marker>
+ DataProvider<provider::time_zones::MetazoneSpecificNamesShortV1Marker>
+ DataProvider<OrdinalV1Marker>
+ DataProvider<DecimalSymbolsV1Marker>
+ ?Sized,
{
let patterns = PatternSelector::for_options_experimental(
provider,
calendar::load_lengths_for_cldr_calendar::<C, _>(provider, locale)?,
locale,
&C::DEFAULT_BCP_47_IDENTIFIER,
&date_time_format_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::ZonedDateTimeFormatter::try_new_unstable(
provider,
patterns,
|| calendar::load_symbols_for_cldr_calendar::<C, _>(provider, locale),
locale,
time_zone_format_options,
)?,
PhantomData,
))
}
/// Takes a [`DateTimeInput`] and a [`TimeZoneInput`] and returns an instance of a [`FormattedZonedDateTime`]
/// that contains all information necessary to display a formatted zoned datetime and operate on it.
///
/// # Examples
///
/// ```
/// use icu::calendar::{DateTime, Gregorian};
/// use icu::datetime::{options::length, TypedZonedDateTimeFormatter};
/// use icu::locid::locale;
/// use icu::timezone::CustomTimeZone;
/// use std::str::FromStr;
/// use writeable::assert_writeable_eq;
///
/// let options = length::Bag::from_date_time_style(
/// length::Date::Medium,
/// length::Time::Long,
/// );
///
/// let zdtf = TypedZonedDateTimeFormatter::<Gregorian>::try_new(
/// &locale!("en").into(),
/// options.into(),
/// Default::default(),
/// )
/// .expect("Failed to create TypedZonedDateTimeFormatter instance.");
///
/// let datetime =
/// DateTime::try_new_gregorian_datetime(2020, 9, 12, 12, 34, 28).unwrap();
/// let time_zone = CustomTimeZone::from_str("-07:00").unwrap();
///
/// let formatted_date = zdtf.format(&datetime, &time_zone);
///
/// assert_writeable_eq!(formatted_date, "Sep 12, 2020, 12:34:28 PM GMT-07:00");
/// ```
#[inline]
pub fn format<'l>(
&'l self,
date: &impl DateTimeInput<Calendar = C>,
time_zone: &impl TimeZoneInput,
) -> FormattedZonedDateTime<'l> {
self.0.format(date, time_zone)
}
/// Takes a [`DateTimeInput`] and a [`TimeZoneInput`] and returns it formatted as a string.
///
/// # Examples
///
/// ```
/// use icu::calendar::{DateTime, Gregorian};
/// use icu::datetime::{options::length, TypedZonedDateTimeFormatter};
/// use icu::locid::locale;
/// use icu::timezone::CustomTimeZone;
/// use std::str::FromStr;
///
/// let options = length::Bag::from_date_time_style(
/// length::Date::Medium,
/// length::Time::Long,
/// );
///
/// let zdtf = TypedZonedDateTimeFormatter::<Gregorian>::try_new(
/// &locale!("en").into(),
/// options.into(),
/// Default::default(),
/// )
/// .expect("Failed to create TypedZonedDateTimeFormatter instance.");
///
/// let datetime =
/// DateTime::try_new_gregorian_datetime(2020, 9, 12, 12, 34, 28).unwrap();
/// let time_zone = CustomTimeZone::from_str("-07:00").unwrap();
///
/// let formatted_string = zdtf.format_to_string(&datetime, &time_zone);
///
/// assert_eq!(formatted_string, "Sep 12, 2020, 12:34:28 PM GMT-07:00");
/// ```
#[inline]
pub fn format_to_string(
&self,
date: &impl DateTimeInput<Calendar = C>,
time_zone: &impl TimeZoneInput,
) -> String {
self.format(date, time_zone).write_to_string().into_owned()
}
}