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 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
// 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 ).
//! Enumerations over [field sets](crate::fieldsets).
//!
//! These enumerations can be used when the field set is not known at compile time. However,
//! they may contribute negatively to the binary size of the formatters.
//!
//! The most general type is [`CompositeFieldSet`], which supports all field
//! sets in a single enumeration. [`CompositeDateTimeFieldSet`] is a good
//! choice when you don't need to format time zones.
//!
//! Summary of all the types:
//!
//! | Type | Supported Field Sets |
//! |---|---|
//! | [`DateFieldSet`] | Date |
//! | [`CalendarPeriodFieldSet`] | Calendar Period |
//! | [`TimeFieldSet`] | Time |
//! | [`ZoneFieldSet`] | Zone |
//! | [`DateAndTimeFieldSet`] | Date + Time |
//! | [`CompositeDateTimeFieldSet`] | Date, Calendar Period, Time, Date + Time |
//! | [`CompositeFieldSet`] | All |
//!
//! # Examples
//!
//! Format with the time display depending on a runtime boolean:
//!
//! ```
//! use icu::calendar::DateTime;
//! use icu::datetime::fieldsets;
//! use icu::datetime::fieldsets::enums::CompositeDateTimeFieldSet;
//! use icu::datetime::DateTimeFormatter;
//! use icu::locale::locale;
//! use writeable::Writeable;
//!
//! fn get_field_set(should_display_time: bool) -> CompositeDateTimeFieldSet {
//! if should_display_time {
//! let field_set = fieldsets::MDT::medium().hm();
//! CompositeDateTimeFieldSet::DateTime(
//! fieldsets::enums::DateAndTimeFieldSet::MDT(field_set),
//! )
//! } else {
//! let field_set = fieldsets::MD::medium();
//! CompositeDateTimeFieldSet::Date(fieldsets::enums::DateFieldSet::MD(
//! field_set,
//! ))
//! }
//! }
//!
//! let datetime = DateTime::try_new_iso(2025, 1, 15, 16, 0, 0).unwrap();
//!
//! let results = [true, false]
//! .map(get_field_set)
//! .map(|field_set| {
//! DateTimeFormatter::try_new(locale!("en-US").into(), field_set)
//! .unwrap()
//! })
//! .map(|formatter| formatter.format_any_calendar(&datetime).to_string());
//!
//! assert_eq!(results, ["Jan 15, 4:00 PM", "Jan 15"])
//! ```
use crate::fieldsets::Combo;
use crate::raw::neo::RawOptions;
use crate::scaffold::GetField;
use crate::{fields, fieldsets};
use icu_provider::prelude::*;
/// An enumeration over all possible date field sets.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum DateFieldSet {
/// The day of the month, as in
/// “on the 1st”.
D(fieldsets::D),
/// The month and day of the month, as in
/// “January 1st”.
MD(fieldsets::MD),
/// The year, month, and day of the month, as in
/// “January 1st, 2000”.
YMD(fieldsets::YMD),
/// The day of the month and day of the week, as in
/// “Saturday 1st”.
DE(fieldsets::DE),
/// The month, day of the month, and day of the week, as in
/// “Saturday, January 1st”.
MDE(fieldsets::MDE),
/// The year, month, day of the month, and day of the week, as in
/// “Saturday, January 1st, 2000”.
YMDE(fieldsets::YMDE),
/// The day of the week alone, as in
/// “Saturday”.
E(fieldsets::E),
}
/// An enumeration over all possible calendar period field sets.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum CalendarPeriodFieldSet {
/// A standalone month, as in
/// “January”.
M(fieldsets::M),
/// A month and year, as in
/// “January 2000”.
YM(fieldsets::YM),
/// A year, as in
/// “2000”.
Y(fieldsets::Y),
// TODO: Add support for week-of-year
// /// The year and week of the year, as in
// /// “52nd week of 1999”.
// YW(fieldsets::YW),
// TODO(#501): Consider adding support for Quarter and YearQuarter.
}
/// An enumeration over all possible time field sets.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum TimeFieldSet {
/// A time of day.
T(fieldsets::T),
}
/// An enumeration over all possible zone field sets.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
///
/// # Time Zone Data Size
///
/// Time zone names contribute a lot of data size. For resource-constrained
/// environments, the following formats require the least amount of data:
///
/// - [`fieldsets::Zs`]
/// - [`fieldsets::O`]
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum ZoneFieldSet {
/// The long specific non-location format, as in
/// “Pacific Daylight Time”.
Z(fieldsets::Z),
/// The short specific non-location format, as in
/// “PDT”.
Zs(fieldsets::Zs),
/// The long offset format, as in
/// “GMT−8:00”.
O(fieldsets::O),
/// The short offset format, as in
/// “GMT−8”.
Os(fieldsets::Os),
/// The long generic non-location format, as in
/// “Pacific Time”.
V(fieldsets::V),
/// The short generic non-location format, as in
/// “PT”.
Vs(fieldsets::Vs),
/// The location format, as in
/// “Los Angeles time”.
L(fieldsets::L),
}
/// An enumeration over all possible date+time composite field sets.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum DateAndTimeFieldSet {
/// The day of the month with time of day, as in
/// “on the 1st at 10:31 AM”.
DT(fieldsets::DT),
/// The month and day of the month with time of day, as in
/// “January 1st at 10:31 AM”.
MDT(fieldsets::MDT),
/// The year, month, and day of the month with time of day, as in
/// “January 1st, 2000 at 10:31 AM”.
YMDT(fieldsets::YMDT),
/// The day of the month and day of the week with time of day, as in
/// “Saturday 1st at 10:31 AM”.
DET(fieldsets::DET),
/// The month, day of the month, and day of the week with time of day, as in
/// “Saturday, January 1st at 10:31 AM”.
MDET(fieldsets::MDET),
/// The year, month, day of the month, and day of the week with time of day, as in
/// “Saturday, January 1st, 2000 at 10:31 AM”.
YMDET(fieldsets::YMDET),
/// The day of the week alone with time of day, as in
/// “Saturday at 10:31 AM”.
ET(fieldsets::ET),
}
/// An enum supporting date, calendar period, time, and date+time field sets
/// and options.
///
/// Time zones are not supported with this enum.
///
/// This enum is useful when formatting a type that does not contain a
/// time zone or to avoid storing time zone data.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum CompositeDateTimeFieldSet {
/// Field set for a date.
Date(DateFieldSet),
/// Field set for a calendar period.
CalendarPeriod(CalendarPeriodFieldSet),
/// Field set for a time.
Time(TimeFieldSet),
/// Field set for a date and a time together.
DateTime(DateAndTimeFieldSet),
}
impl CompositeDateTimeFieldSet {
/// If the [`CompositeFieldSet`] does not contain a time zone,
/// returns the corresponding [`CompositeDateTimeFieldSet`].
pub fn try_from_composite_field_set(field_set: CompositeFieldSet) -> Option<Self> {
match field_set {
CompositeFieldSet::Date(v) => Some(Self::Date(v)),
CompositeFieldSet::CalendarPeriod(v) => Some(Self::CalendarPeriod(v)),
CompositeFieldSet::Time(v) => Some(Self::Time(v)),
CompositeFieldSet::Zone(_) => None,
CompositeFieldSet::DateTime(v) => Some(Self::DateTime(v)),
CompositeFieldSet::DateZone(_) => None,
CompositeFieldSet::TimeZone(_) => None,
CompositeFieldSet::DateTimeZone(_) => None,
}
}
/// Returns the [`CompositeFieldSet`] corresponding to this
/// [`CompositeDateTimeFieldSet`].
pub fn to_composite_field_set(self) -> CompositeFieldSet {
match self {
Self::Date(v) => CompositeFieldSet::Date(v),
Self::CalendarPeriod(v) => CompositeFieldSet::CalendarPeriod(v),
Self::Time(v) => CompositeFieldSet::Time(v),
Self::DateTime(v) => CompositeFieldSet::DateTime(v),
}
}
}
impl GetField<CompositeFieldSet> for CompositeDateTimeFieldSet {
fn get_field(&self) -> CompositeFieldSet {
self.to_composite_field_set()
}
}
/// An enum supporting all possible field sets and options.
///
/// This is a dynamic field set. For more information, see [`enums`](crate::fieldsets::enums).
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum CompositeFieldSet {
/// Field set for a date.
Date(DateFieldSet),
/// Field set for a calendar period.
CalendarPeriod(CalendarPeriodFieldSet),
/// Field set for a time.
Time(TimeFieldSet),
/// Field set for a time zone.
Zone(ZoneFieldSet),
/// Field set for a date and a time together.
DateTime(DateAndTimeFieldSet),
/// Field set for a date and a time zone together.
DateZone(Combo<DateFieldSet, ZoneFieldSet>),
/// Field set for a time and a time zone together.
TimeZone(Combo<TimeFieldSet, ZoneFieldSet>),
/// Field set for a date, a time, and a time zone together.
DateTimeZone(Combo<DateAndTimeFieldSet, ZoneFieldSet>),
}
macro_rules! first {
($first:literal, $($remainder:literal,)*) => {
$first
};
}
macro_rules! impl_attrs {
(@attrs, $type:path, [$(($attr_var:ident, $str_var:ident, $value:literal),)+]) => {
impl $type {
$(
const $attr_var: &'static DataMarkerAttributes = DataMarkerAttributes::from_str_or_panic($value);
)+
/// All attributes associated with this enum.
///
/// # Encoding Details
///
/// The string is based roughly on the UTS 35 symbol table with the following exceptions:
///
/// 1. Lowercase letters are chosen where there is no ambiguity: `E` becomes `e`
/// 2. Capitals are replaced with their lowercase and a number 0: `M` becomes `m0`
/// 3. A single symbol is included for each component: length doesn't matter
/// 4. Time fields are encoded with their hour field only: `j`, `h`, or `h0`
///
/// # Examples
///
/// ```
#[doc = concat!("use icu::datetime::fieldsets::enums::", stringify!($type), " as FS;")]
/// use icu_provider::DataMarkerAttributes;
///
/// assert!(FS::ALL_DATA_MARKER_ATTRIBUTES.contains(
#[doc = concat!(" &DataMarkerAttributes::from_str_or_panic(\"", first!($($value,)*), "\")")]
/// ));
/// ```
pub const ALL_DATA_MARKER_ATTRIBUTES: &'static [&'static DataMarkerAttributes] = &[
$(
Self::$attr_var,
)+
];
}
};
(@id_str, $type:path, [$(($variant:ident, $attr_var:ident)),+,]) => {
impl $type {
/// Returns a stable string identifying this set of fields.
pub(crate) const fn id_str(self) -> &'static DataMarkerAttributes {
match self {
$(
Self::$variant(_) => Self::$attr_var,
)+
}
}
}
};
(@to_raw_options, $type:path, [$($variant:ident),+,]) => {
impl $type {
pub(crate) fn to_raw_options(self) -> RawOptions {
match self {
$(
Self::$variant(variant) => variant.to_raw_options(),
)+
}
}
}
};
(@composite, $type:path, $variant:ident) => {
impl $type {
#[inline]
pub(crate) fn to_enum(self) -> $type {
self
}
}
impl GetField<CompositeFieldSet> for $type {
#[inline]
fn get_field(&self) -> CompositeFieldSet {
CompositeFieldSet::$variant(self.to_enum())
}
}
};
(@date, $type:path, [$(($variant:ident, $attr_var:ident, $str_var:ident, $value:literal)),+,]) => {
impl_attrs! { @attrs, $type, [$(($attr_var, $str_var, $value)),+,] }
impl_attrs! { @id_str, $type, [$(($variant, $attr_var)),+,] }
impl_attrs! { @to_raw_options, $type, [$($variant),+,] }
impl_attrs! { @composite, $type, Date }
};
(@calendar_period, $type:path, [$(($variant:ident, $attr_var:ident, $str_var:ident, $value:literal)),+,]) => {
impl_attrs! { @attrs, $type, [$(($attr_var, $str_var, $value)),+,] }
impl_attrs! { @to_raw_options, $type, [$($variant),+,] }
impl_attrs! { @composite, $type, CalendarPeriod }
impl_attrs! { @id_str, $type, [$(($variant, $attr_var)),+,] }
};
(@time, $type:path, [$(($attr_var:ident, $str_var:ident, $value:literal)),+,]) => {
impl_attrs! { @attrs, $type, [$(($attr_var, $str_var, $value)),+,] }
impl_attrs! { @to_raw_options, $type, [T,] }
impl_attrs! { @composite, $type, Time }
};
(@zone, $type:path, [$($variant:ident),+,]) => {
impl_attrs! { @composite, $type, Zone }
impl $type {
pub(crate) fn to_field(self) -> (fields::TimeZone, fields::FieldLength) {
match self {
$(
Self::$variant(variant) => variant.to_field(),
)+
}
}
}
};
(@datetime, $type:path, [$(($d_variant:ident, $variant:ident)),+,]) => {
impl_attrs! { @to_raw_options, $type, [$($variant),+,] }
impl_attrs! { @composite, $type, DateTime }
impl $type {
pub(crate) fn to_date_field_set(self) -> DateFieldSet {
match self {
$(
Self::$variant(variant) => DateFieldSet::$d_variant(variant.to_date_field_set()),
)+
}
}
pub(crate) fn to_time_field_set(self) -> TimeFieldSet {
let (length, time_precision, alignment) = match self {
$(
Self::$variant(variant) => (variant.length, variant.time_precision, variant.alignment),
)+
};
TimeFieldSet::T(fieldsets::T {
length,
time_precision,
alignment,
})
}
#[cfg(all(feature = "serde", feature = "experimental"))]
pub(crate) fn from_date_field_set_with_raw_options(date_field_set: DateFieldSet, options: RawOptions) -> Self {
match date_field_set {
$(
DateFieldSet::$d_variant(_) => Self::$variant(fieldsets::$variant::from_raw_options(options)),
)+
}
}
}
};
}
impl_attrs! {
@date,
DateFieldSet,
[
(D, ATTR_D, STR_D, "d"),
(MD, ATTR_MD, STR_MD, "m0d"),
(YMD, ATTR_YMD, STR_YMD, "ym0d"),
(DE, ATTR_DE, STR_DE, "de"),
(MDE, ATTR_MDE, STR_MDE, "m0de"),
(YMDE, ATTR_YMDE, STR_YMDE, "ym0de"),
(E, ATTR_E, STR_E, "e"),
]
}
impl_attrs! {
@calendar_period,
CalendarPeriodFieldSet,
[
(M, ATTR_M, STR_M, "m0"),
(YM, ATTR_YM, STR_YM, "ym0"),
(Y, ATTR_Y, STR_Y, "y"),
]
}
impl_attrs! {
@time,
TimeFieldSet,
[
(ATTR_T, STR_T, "j"),
(ATTR_T12, STR_T12, "h"),
(ATTR_T24, STR_T24, "h0"),
]
}
impl TimeFieldSet {
pub(crate) const fn id_str_for_hour_cycle(
self,
hour_cycle: Option<fields::Hour>,
) -> &'static DataMarkerAttributes {
use fields::Hour::*;
match hour_cycle {
None => Self::ATTR_T,
Some(H11 | H12) => Self::ATTR_T12,
Some(H23 | H24) => Self::ATTR_T24,
}
}
}
impl_attrs! {
@zone,
ZoneFieldSet,
[
Z,
Zs,
O,
Os,
V,
Vs,
L,
]
}
impl_attrs! {
@attrs,
DateAndTimeFieldSet,
[
(ATTR_ET, STR_ET, "ej"),
]
}
impl_attrs! {
@datetime,
DateAndTimeFieldSet,
[
(D, DT),
(MD, MDT),
(YMD, YMDT),
(DE, DET),
(MDE, MDET),
(YMDE, YMDET),
(E, ET),
]
}
impl DateAndTimeFieldSet {
pub(crate) const fn id_str(self) -> Option<&'static DataMarkerAttributes> {
match self {
DateAndTimeFieldSet::ET(_) => Some(Self::ATTR_ET),
_ => None,
}
}
}