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 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
// 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 ).
//! 🚧 \[Experimental\] Options for constructing DateTimeFormatter objects by each component style.
//!
//! ✨ *Enabled with the `experimental` Cargo feature.*
//!
//! <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>
//!
//! # Implementation status
//!
//! This module is available by enabling the `"experimental"` Cargo feature.
//! It may change in breaking ways, including across minor releases.
//!
//! This is currently only a partial implementation of the UTS-35 skeleton matching algorithm.
//!
//! | Algorithm step | Status |
//! |----------------|--------|
//! | Match skeleton fields according to a ranking | Implemented |
//! | Adjust the matched pattern to have certain widths | Implemented |
//! | Match date and times separately, and them combine them | Implemented |
//! | Use appendItems to fill in a pattern with missing fields | Not yet, and may not be fully implemented. See [issue #586](https://github.com/unicode-org/icu4x/issues/586) |
//!
//! # Description
//!
//! A [`components::Bag`](struct.Bag.html) is a model of encoding information on how to format date
//! and time by specifying a list of components the user wants to be visible in the formatted string
//! and how each field should be displayed.
//!
//! This model closely corresponds to `ECMA402` API and allows for high level of customization
//! compared to `Length` model.
//!
//! Additionally, the bag contains an optional set of `Preferences` which represent user
//! preferred adjustments that can be applied onto the pattern right before formatting.
//!
//! ## Pattern Selection
//!
//! The [`components::Bag`](struct.Bag.html) is a way for the developer to describe which components
//! should be included in in a datetime, and how they should be displayed. There is not a strict
//! guarantee in how the final date will be displayed to the end user. The user's preferences and
//! locale information can override the developer preferences.
//!
//! The fields in the [`components::Bag`](struct.Bag.html) are matched against available patterns in
//! the `CLDR` locale data. A best fit is found, and presented to the user. This means that in
//! certain situations, and component combinations, fields will not have a match, or the match will
//! have a different type of presentation for a given locale.
//!
//!
//! # Examples
//!
//! ```
//! use icu::datetime::options::components;
//! use icu::datetime::options::DateTimeFormatterOptions;
//!
//! let mut bag = components::Bag::default();
//! bag.year = Some(components::Year::Numeric);
//! bag.month = Some(components::Month::Long);
//! bag.day = Some(components::Day::NumericDayOfMonth);
//!
//! bag.hour = Some(components::Numeric::TwoDigit);
//! bag.minute = Some(components::Numeric::TwoDigit);
//!
//! // The options can be created manually.
//! let options = DateTimeFormatterOptions::Components(bag);
//! ```
//!
//! Or the options can be inferred through the `.into()` trait.
//!
//! ```
//! use icu::datetime::options::components;
//! use icu::datetime::options::DateTimeFormatterOptions;
//! let options: DateTimeFormatterOptions = components::Bag::default().into();
//! ```
//!
//! *Note*: The exact formatted result is a subject to change over
//! time. Formatted result should be treated as opaque and displayed to the user as-is,
//! and it is strongly recommended to never write tests that expect a particular formatted output.
use crate::{
fields::{self, Field, FieldLength, FieldSymbol},
neo_skeleton::FractionalSecondDigits,
provider::pattern::{runtime::Pattern, PatternItem},
provider::skeleton::PatternPlurals,
};
use super::preferences;
use crate::neo_pattern::DateTimePattern;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
/// See the [module-level](./index.html) docs for more information.
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
#[non_exhaustive]
pub struct Bag {
/// Include the era, such as "AD" or "CE".
pub era: Option<Text>,
/// Include the year, such as "1970" or "70".
pub year: Option<Year>,
/// Include the month, such as "April" or "Apr".
pub month: Option<Month>,
/// Include the week number, such as "51st" or "51" for week 51.
pub week: Option<Week>,
/// Include the day of the month/year, such as "07" or "7".
pub day: Option<Day>,
/// Include the weekday, such as "Wednesday" or "Wed".
pub weekday: Option<Text>,
/// Include the hour such as "2" or "14".
pub hour: Option<Numeric>,
/// Include the minute such as "3" or "03".
pub minute: Option<Numeric>,
/// Include the second such as "3" or "03".
pub second: Option<Numeric>,
/// Specify the number of fractional second digits such as 1 (".3") or 3 (".003").
pub fractional_second: Option<FractionalSecondDigits>,
/// Include the time zone, such as "GMT+05:00".
pub time_zone_name: Option<TimeZoneName>,
/// Adjust the preferences for the date, such as setting the hour cycle.
pub preferences: Option<preferences::Bag>,
}
impl Bag {
/// Creates an empty components bag
///
/// Has the same behavior as the [`Default`] implementation on this type.
pub fn empty() -> Self {
Self::default()
}
/// Merges the fields of other into self if non-None. If both fields are set, `other` is kept.
pub fn merge(self, other: Self) -> Self {
Self {
era: other.era.or(self.era),
year: other.year.or(self.year),
month: other.month.or(self.month),
week: other.week.or(self.week),
day: other.day.or(self.day),
weekday: other.weekday.or(self.weekday),
hour: other.hour.or(self.hour),
minute: other.minute.or(self.minute),
second: other.second.or(self.second),
fractional_second: other.fractional_second.or(self.fractional_second),
time_zone_name: other.time_zone_name.or(self.time_zone_name),
preferences: other.preferences.or(self.preferences),
}
}
#[allow(clippy::wrong_self_convention)]
/// Converts the components::Bag into a `Vec<Field>`. The fields will be ordered in from most
/// significant field to least significant. This is the order the fields are listed in
/// the UTS 35 table - <https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table>
///
/// Arguments:
///
/// - `default_hour_cycle` specifies the hour cycle to use for the hour field if not in the Bag.
/// `preferences::Bag::hour_cycle` takes precedence over this argument.
#[cfg(feature = "datagen")]
pub fn to_vec_fields(
&self,
default_hour_cycle: preferences::HourCycle,
) -> alloc::vec::Vec<Field> {
let mut fields = alloc::vec::Vec::new();
if let Some(era) = self.era {
fields.push(Field {
symbol: FieldSymbol::Era,
length: match era {
// Era name, format length.
//
// G..GGG AD Abbreviated
// GGGG Anno Domini Wide
// GGGGG A Narrow
Text::Short => FieldLength::Three,
Text::Long => FieldLength::Four,
Text::Narrow => FieldLength::Five,
},
})
}
if let Some(year) = self.year {
// Unimplemented year fields:
// u - Extended year
// U - Cyclic year name
// r - Related Gregorian year
fields.push(Field {
symbol: FieldSymbol::Year(match year {
Year::Numeric | Year::TwoDigit => fields::Year::Calendar,
Year::NumericWeekOf | Year::TwoDigitWeekOf => {
unimplemented!("fields::Year::WeekOf")
}
}),
length: match year {
// Calendar year (numeric).
// y 2, 20, 201, 2017, 20173
// yy 02, 20, 01, 17, 73
// yyy 002, 020, 201, 2017, 20173 (not implemented)
// yyyy 0002, 0020, 0201, 2017, 20173 (not implemented)
// yyyyy+ ... (not implemented)
Year::Numeric | Year::NumericWeekOf => FieldLength::One,
Year::TwoDigit | Year::TwoDigitWeekOf => FieldLength::Two,
},
});
}
// TODO(#501) - Unimplemented quarter fields:
// Q - Quarter number/name
// q - Stand-alone quarter
if let Some(month) = self.month {
fields.push(Field {
// Always choose Month::Format as Month::StandAlone is not used in skeletons.
symbol: FieldSymbol::Month(fields::Month::Format),
length: match month {
// (intended to be used in conjunction with ‘d’ for day number).
// M 9, 12 Numeric: minimum digits
// MM 09, 12 Numeric: 2 digits, zero pad if needed
// MMM Sep Abbreviated
// MMMM September Wide
// MMMMM S Narrow
Month::Numeric => FieldLength::One,
Month::TwoDigit => FieldLength::Two,
Month::Long => FieldLength::Four,
Month::Short => FieldLength::Three,
Month::Narrow => FieldLength::Five,
},
});
}
if let Some(week) = self.week {
#[allow(unreachable_code)]
fields.push(Field {
symbol: FieldSymbol::Week(match week {
Week::WeekOfMonth => unimplemented!("#5643 fields::Week::WeekOfMonth"),
Week::NumericWeekOfYear | Week::TwoDigitWeekOfYear => {
unimplemented!("#5643 fields::Week::WeekOfYear")
}
}),
length: match week {
Week::WeekOfMonth | Week::NumericWeekOfYear => FieldLength::One,
Week::TwoDigitWeekOfYear => FieldLength::Two,
},
});
}
if let Some(day) = self.day {
// TODO(#591) Unimplemented day fields:
// g - Modified Julian day.
fields.push(Field {
symbol: FieldSymbol::Day(match day {
Day::NumericDayOfMonth | Day::TwoDigitDayOfMonth => fields::Day::DayOfMonth,
Day::DayOfWeekInMonth => fields::Day::DayOfWeekInMonth,
Day::DayOfYear => fields::Day::DayOfYear,
}),
length: match day {
// d 1 Numeric day of month: minimum digits
// dd 01 Numeric day of month: 2 digits, zero pad if needed
// F 1 Numeric day of week in month: minimum digits
// D 1 Numeric day of year: minimum digits
Day::NumericDayOfMonth | Day::DayOfWeekInMonth | Day::DayOfYear => {
FieldLength::One
}
Day::TwoDigitDayOfMonth => FieldLength::Two,
},
});
}
if let Some(weekday) = self.weekday {
// TODO(#593) Unimplemented fields
// e - Local day of week.
// c - Stand-alone local day of week.
fields.push(Field {
symbol: FieldSymbol::Weekday(fields::Weekday::Format),
length: match weekday {
// Day of week name, format length.
//
// E..EEE Tue Abbreviated
// EEEE Tuesday Wide
// EEEEE T Narrow
// EEEEEE Tu Short
Text::Long => FieldLength::Four,
Text::Short => FieldLength::One,
Text::Narrow => FieldLength::Five,
},
});
}
// The period fields are not included in skeletons:
// a - AM, PM
// b - am, pm, noon, midnight
// c - flexible day periods
if let Some(hour) = self.hour {
// fields::Hour::H11
// fields::Hour::H12
// fields::Hour::H23
// fields::Hour::H24
let hour_cycle = match self.preferences {
Some(preferences::Bag {
hour_cycle: Some(hour_cycle),
}) => hour_cycle,
_ => default_hour_cycle,
};
// When used in skeleton data or in a skeleton passed in an API for flexible date
// pattern generation, it should match the 12-hour-cycle format preferred by the
// locale (h or K); it should not match a 24-hour-cycle format (H or k).
fields.push(Field {
symbol: FieldSymbol::Hour(match hour_cycle {
// Skeletons only contain the h12, not h11. The pattern that is matched
// is free to use h11 or h12.
preferences::HourCycle::H11 | preferences::HourCycle::H12 => {
// h - symbol
fields::Hour::H12
}
// Skeletons only contain the h23, not h24. The pattern that is matched
// is free to use h23 or h24.
preferences::HourCycle::H24 | preferences::HourCycle::H23 => {
// H - symbol
fields::Hour::H23
}
}),
length: match hour {
// Example for h: (note that this is the same for k, K, and H)
// h 1, 12 Numeric: minimum digits
// hh 01, 12 Numeric: 2 digits, zero pad if needed
Numeric::Numeric => FieldLength::One,
Numeric::TwoDigit => FieldLength::Two,
},
});
}
if let Some(minute) = self.minute {
// m 8, 59 Numeric: minimum digits
// mm 08, 59 Numeric: 2 digits, zero pad if needed
fields.push(Field {
symbol: FieldSymbol::Minute,
length: match minute {
Numeric::Numeric => FieldLength::One,
Numeric::TwoDigit => FieldLength::Two,
},
});
}
if let Some(second) = self.second {
let symbol = match self.fractional_second {
None => FieldSymbol::Second(fields::Second::Second),
Some(fractional_second) => {
FieldSymbol::from_fractional_second_digits(fractional_second)
}
};
// s 8, 12 Numeric: minimum digits
// ss 08, 12 Numeric: 2 digits, zero pad if needed
fields.push(Field {
symbol,
length: match second {
Numeric::Numeric => FieldLength::One,
Numeric::TwoDigit => FieldLength::Two,
},
});
// S - Fractional seconds. Represented as DecimalSecond.
// A - Milliseconds in day. Not used in skeletons.
}
if self.time_zone_name.is_some() {
// Only the lower "v" field is used in skeletons.
fields.push(Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::GenericNonLocation),
length: FieldLength::One,
});
}
{
#![allow(clippy::indexing_slicing)] // debug
debug_assert!(
fields.windows(2).all(|f| f[0] < f[1]),
"The fields are sorted and unique."
);
}
fields
}
}
/// A numeric component for the `components::`[`Bag`]. It is used for the year, day, hour, minute,
/// and second.
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum Numeric {
/// Display the numeric value. For instance in a year this would be "1970".
Numeric,
/// Display the two digit value. For instance in a year this would be "70".
TwoDigit,
}
/// A text component for the `components::`[`Bag`]. It is used for the era and weekday.
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum Text {
/// Display the long form of the text, such as "Wednesday" for the weekday.
/// In UTS-35, known as "Wide" (4 letters)
Long,
/// Display the short form of the text, such as "Wed" for the weekday.
/// In UTS-35, known as "Abbreviated" (3 letters)
Short,
/// Display the narrow form of the text, such as "W" for the weekday.
/// In UTS-35, known as "Narrow" (5 letters)
Narrow,
}
/// Options for displaying a Year for the `components::`[`Bag`].
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum Year {
/// The numeric value of the year, such as "2018" for 2018-12-31.
Numeric,
/// The two-digit value of the year, such as "18" for 2018-12-31.
TwoDigit,
/// The numeric value of the year in "week-of-year", such as "2019" in
/// "week 01 of 2019" for the week of 2018-12-31 according to the ISO calendar.
NumericWeekOf,
/// The numeric value of the year in "week-of-year", such as "19" in
/// "week 01 '19" for the week of 2018-12-31 according to the ISO calendar.
TwoDigitWeekOf,
}
/// Options for displaying a Month for the `components::`[`Bag`].
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum Month {
/// The numeric value of the month, such as "4".
Numeric,
/// The two-digit value of the month, such as "04".
TwoDigit,
/// The long value of the month, such as "April".
Long,
/// The short value of the month, such as "Apr".
Short,
/// The narrow value of the month, such as "A".
Narrow,
}
// Each enum variant is documented with the UTS 35 field information from:
// https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
/// Options for displaying the current week number for the `components::`[`Bag`].
///
/// Week numbers are relative to either a month or year, e.g. 'week 3 of January' or 'week 40 of 2000'.
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum Week {
/// The week of the month, such as the "3" in "week 3 of January".
WeekOfMonth,
/// The numeric value of the week of the year, such as the "8" in "week 8 of 2000".
NumericWeekOfYear,
/// The two-digit value of the week of the year, such as the "08" in "2000-W08".
TwoDigitWeekOfYear,
}
/// Options for displaying the current day of the month or year.
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum Day {
/// The numeric value of the day of month, such as the "2" in July 2 1984.
NumericDayOfMonth,
/// The two digit value of the day of month, such as the "02" in 1984-07-02.
TwoDigitDayOfMonth,
/// The day of week in this month, such as the "2" in 2nd Wednesday of July.
DayOfWeekInMonth,
/// The day of year (numeric).
DayOfYear,
}
/// Options for displaying a time zone for the `components::`[`Bag`].
///
/// Note that the initial implementation is focusing on only supporting ECMA-402 compatible
/// options.
///
/// <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>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(rename_all = "kebab-case")
)]
#[non_exhaustive]
pub enum TimeZoneName {
// UTS-35 fields: z..zzz
/// Short localized form, without the location. (e.g.: PST, GMT-8)
ShortSpecific,
// UTS-35 fields: zzzz
// Per UTS-35: [long form] specific non-location (falling back to long localized offset)
/// Long localized form, without the location (e.g., Pacific Standard Time, Nordamerikanische Westküsten-Normalzeit)
LongSpecific,
// UTS-35 fields: OOOO
// Per UTS-35: The long localized offset format. This is equivalent to the "OOOO" specifier
/// Long localized offset form, e.g. GMT-08:00
LongOffset,
// UTS-35 fields: O
// Per UTS-35: Short localized offset format
/// Short localized offset form, e.g. GMT-8
ShortOffset,
// UTS-35 fields: v
// * falling back to generic location (See UTS 35 for more specific rules)
// * falling back to short localized offset
/// Short generic non-location format (e.g.: PT, Los Angeles, Zeit).
ShortGeneric,
// UTS-35 fields: vvvv
// * falling back to generic location (See UTS 35 for more specific rules)
// * falling back to long localized offset
/// Long generic non-location format (e.g.: Pacific Time, Nordamerikanische Westküstenzeit),
LongGeneric,
}
impl From<TimeZoneName> for Field {
fn from(time_zone_name: TimeZoneName) -> Self {
match time_zone_name {
TimeZoneName::ShortSpecific => Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::SpecificNonLocation),
length: FieldLength::One,
},
TimeZoneName::LongSpecific => Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::SpecificNonLocation),
length: FieldLength::Four,
},
TimeZoneName::LongOffset => Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::LocalizedOffset),
length: FieldLength::Four,
},
TimeZoneName::ShortOffset => Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::LocalizedOffset),
length: FieldLength::One,
},
TimeZoneName::ShortGeneric => Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::GenericNonLocation),
length: FieldLength::One,
},
TimeZoneName::LongGeneric => Field {
symbol: FieldSymbol::TimeZone(fields::TimeZone::GenericNonLocation),
length: FieldLength::Four,
},
}
}
}
/// Get the resolved components for a FixedCalendarDateTimeFormatter, via the PatternPlurals. In the case of
/// plurals resolve off of the required `other` pattern.
impl From<&PatternPlurals<'_>> for Bag {
fn from(other: &PatternPlurals) -> Self {
let pattern = match other {
PatternPlurals::SinglePattern(pattern) => pattern,
PatternPlurals::MultipleVariants(plural_pattern) => &plural_pattern.other,
};
Self::from(pattern)
}
}
impl From<&DateTimePattern> for Bag {
fn from(value: &DateTimePattern) -> Self {
Self::from(value.as_borrowed().0)
}
}
impl From<&Pattern<'_>> for Bag {
fn from(pattern: &Pattern) -> Self {
let mut bag: Bag = Default::default();
// Transform the fields into components per:
// https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
for item in pattern.items.iter() {
let field = match item {
PatternItem::Field(ref field) => field,
PatternItem::Literal(_) => continue,
};
match field.symbol {
FieldSymbol::Era => {
bag.era = Some(match field.length {
FieldLength::One
| FieldLength::NumericOverride(_)
| FieldLength::Two
| FieldLength::Three => Text::Short,
FieldLength::Four => Text::Long,
FieldLength::Five | FieldLength::Six => Text::Narrow,
});
}
FieldSymbol::Year(year) => {
bag.year = Some(match year {
fields::Year::Calendar => match field.length {
FieldLength::Two => Year::TwoDigit,
_ => Year::Numeric,
},
// fields::Year::WeekOf => match field.length {
// FieldLength::TwoDigit => Year::TwoDigitWeekOf,
// _ => Year::NumericWeekOf,
// },
// TODO(#3762): Add support for U and r
_ => Year::Numeric,
});
}
FieldSymbol::Month(_) => {
// `Month::StandAlone` is only relevant in the pattern, so only differentiate
// on the field length.
bag.month = Some(match field.length {
FieldLength::One => Month::Numeric,
FieldLength::NumericOverride(_) => Month::Numeric,
FieldLength::Two => Month::TwoDigit,
FieldLength::Three => Month::Short,
FieldLength::Four => Month::Long,
FieldLength::Five | FieldLength::Six => Month::Narrow,
});
}
FieldSymbol::Week(_week) => {
// TODO(#5643): Add week fields back
// bag.week = Some(match week {
// fields::Week::WeekOfYear => match field.length {
// FieldLength::TwoDigit => Week::TwoDigitWeekOfYear,
// _ => Week::NumericWeekOfYear,
// },
// fields::Week::WeekOfMonth => Week::WeekOfMonth,
// });
}
FieldSymbol::Day(day) => {
bag.day = Some(match day {
fields::Day::DayOfMonth => match field.length {
FieldLength::Two => Day::TwoDigitDayOfMonth,
_ => Day::NumericDayOfMonth,
},
fields::Day::DayOfYear => Day::DayOfYear,
fields::Day::DayOfWeekInMonth => Day::DayOfWeekInMonth,
});
}
FieldSymbol::Weekday(weekday) => {
bag.weekday = Some(match weekday {
fields::Weekday::Format => match field.length {
FieldLength::One | FieldLength::Two | FieldLength::Three => Text::Short,
FieldLength::Four => Text::Long,
_ => Text::Narrow,
},
fields::Weekday::StandAlone => match field.length {
FieldLength::One
| FieldLength::Two
| FieldLength::NumericOverride(_) => {
// Stand-alone fields also support a numeric 1 digit per UTS-35, but there is
// no way to request it using the current system. As of 2021-12-06
// no skeletons resolve to patterns containing this symbol.
//
// All resolved patterns from cldr-json:
// https://github.com/gregtatum/cldr-json/blob/d4779f9611a4cc1e3e6a0a4597e92ead32d9f118/stand-alone-week.js
// 'ccc',
// 'ccc d. MMM',
// 'ccc d. MMMM',
// 'cccc d. MMMM y',
// 'd, ccc',
// 'cccနေ့',
// 'ccc, d MMM',
// "ccc, d 'de' MMMM",
// "ccc, d 'de' MMMM 'de' y",
// 'ccc, h:mm B',
// 'ccc, h:mm:ss B',
// 'ccc, d',
// "ccc, dd.MM.y 'г'.",
// 'ccc, d.MM.y',
// 'ccc, MMM d. y'
unimplemented!("Numeric stand-alone fields are not supported.")
}
FieldLength::Three => Text::Short,
FieldLength::Four => Text::Long,
FieldLength::Five | FieldLength::Six => Text::Narrow,
},
fields::Weekday::Local => unimplemented!("fields::Weekday::Local"),
});
}
FieldSymbol::DayPeriod(_) => {
// Day period does not affect the resolved components.
}
FieldSymbol::Hour(hour) => {
bag.hour = Some(match field.length {
FieldLength::Two => Numeric::TwoDigit,
_ => Numeric::Numeric,
});
bag.preferences = Some(preferences::Bag {
hour_cycle: Some(match hour {
fields::Hour::H11 => preferences::HourCycle::H11,
fields::Hour::H12 => preferences::HourCycle::H12,
fields::Hour::H23 => preferences::HourCycle::H23,
fields::Hour::H24 => preferences::HourCycle::H24,
}),
});
}
FieldSymbol::Minute => {
bag.minute = Some(match field.length {
FieldLength::Two => Numeric::TwoDigit,
_ => Numeric::Numeric,
});
}
FieldSymbol::Second(second) => match second {
fields::Second::Second => {
bag.second = Some(match field.length {
FieldLength::Two => Numeric::TwoDigit,
_ => Numeric::Numeric,
});
}
fields::Second::MillisInDay => unimplemented!("fields::Second::MillisInDay"),
},
FieldSymbol::DecimalSecond(decimal_second) => {
use FractionalSecondDigits::*;
bag.second = Some(match field.length {
FieldLength::Two => Numeric::TwoDigit,
_ => Numeric::Numeric,
});
bag.fractional_second = Some(match decimal_second {
fields::DecimalSecond::SecondF1 => F1,
fields::DecimalSecond::SecondF2 => F2,
fields::DecimalSecond::SecondF3 => F3,
fields::DecimalSecond::SecondF4 => F4,
fields::DecimalSecond::SecondF5 => F5,
fields::DecimalSecond::SecondF6 => F6,
fields::DecimalSecond::SecondF7 => F7,
fields::DecimalSecond::SecondF8 => F8,
fields::DecimalSecond::SecondF9 => F9,
});
}
FieldSymbol::TimeZone(time_zone_name) => {
bag.time_zone_name = Some(match time_zone_name {
fields::TimeZone::SpecificNonLocation => match field.length {
FieldLength::One => TimeZoneName::ShortSpecific,
_ => TimeZoneName::LongSpecific,
},
fields::TimeZone::GenericNonLocation => match field.length {
FieldLength::One => TimeZoneName::ShortGeneric,
_ => TimeZoneName::LongGeneric,
},
fields::TimeZone::LocalizedOffset => match field.length {
FieldLength::One => TimeZoneName::ShortOffset,
_ => TimeZoneName::LongOffset,
},
fields::TimeZone::Location => unimplemented!("fields::TimeZone::Location"),
fields::TimeZone::Iso => unimplemented!("fields::TimeZone::IsoZ"),
fields::TimeZone::IsoWithZ => unimplemented!("fields::TimeZone::Iso"),
});
}
}
}
bag
}
}
#[cfg(test)]
mod test {
use super::*;
// Shorten these for terser tests.
type Symbol = FieldSymbol;
type Length = FieldLength;
#[test]
fn test_component_bag_to_vec_field() {
let bag = Bag {
year: Some(Year::Numeric),
month: Some(Month::Long),
// TODO(#5643): Add week fields back
week: None,
day: Some(Day::NumericDayOfMonth),
hour: Some(Numeric::Numeric),
minute: Some(Numeric::Numeric),
second: Some(Numeric::Numeric),
fractional_second: Some(FractionalSecondDigits::F3),
..Default::default()
};
assert_eq!(
bag.to_vec_fields(preferences::HourCycle::H23),
[
(Symbol::Year(fields::Year::Calendar), Length::One).into(),
(Symbol::Month(fields::Month::Format), Length::Four).into(),
(Symbol::Day(fields::Day::DayOfMonth), Length::One).into(),
(Symbol::Hour(fields::Hour::H23), Length::One).into(),
(Symbol::Minute, Length::One).into(),
(
Symbol::DecimalSecond(fields::DecimalSecond::SecondF3),
Length::One
)
.into(),
]
);
}
#[test]
fn test_component_bag_to_vec_field2() {
let bag = Bag {
year: Some(Year::Numeric),
month: Some(Month::TwoDigit),
day: Some(Day::NumericDayOfMonth),
..Default::default()
};
assert_eq!(
bag.to_vec_fields(preferences::HourCycle::H23),
[
(Symbol::Year(fields::Year::Calendar), Length::One).into(),
(Symbol::Month(fields::Month::Format), Length::Two).into(),
(Symbol::Day(fields::Day::DayOfMonth), Length::One).into(),
]
);
}
}