icu_calendar 2.2.1

Date APIs for Gregorian and non-Gregorian calendars
Documentation 
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

// 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 ).

//! Locale preferences used by this crate

#[doc(inline)]
/// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
#[doc = "\n"] // prevent autoformatting
pub use icu_locale_core::preferences::extensions::unicode::keywords::CalendarAlgorithm;
/// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
#[doc = "\n"] // prevent autoformatting
pub use icu_locale_core::preferences::extensions::unicode::keywords::FirstDay;
#[doc(inline)]
/// **This is a reexport of a type in [`icu::locale`](icu_locale_core::preferences::extensions::unicode::keywords)**.
#[doc = "\n"] // prevent autoformatting
pub use icu_locale_core::preferences::extensions::unicode::keywords::HijriCalendarAlgorithm;

use icu_locale_core::preferences::define_preferences;

define_preferences!(
    /// The preferences for calendars formatting.
    [Copy]
    CalendarPreferences,
    {
        /// The user's preferred calendar system.
        calendar_algorithm: CalendarAlgorithm
    }
);

define_preferences!(
    /// The preferences for the week information.
    [Copy]
    WeekPreferences,
    {
        /// The first day of the week
        first_weekday: FirstDay
    }
);

impl CalendarPreferences {
    /// Selects the [`CalendarAlgorithm`] appropriate for the given [`CalendarPreferences`].
    ///
    /// This is guaranteed to return a [`CalendarAlgorithm`] that successfully converts into an
    /// [`AnyCalendarKind`](crate::AnyCalendarKind) (i.e. not `-u-ca-islamic` or `-u-ca-islamic-rgsa`).
    ///
    /// # Example
    ///
    /// ```
    /// use icu::calendar::preferences::{CalendarAlgorithm, CalendarPreferences, HijriCalendarAlgorithm};
    /// use icu::locale::locale;
    ///
    /// assert_eq!(CalendarPreferences::from(&locale!("und")).resolved_algorithm(), CalendarAlgorithm::Gregory);
    /// assert_eq!(CalendarPreferences::from(&locale!("und-US-u-ca-hebrew")).resolved_algorithm(), CalendarAlgorithm::Hebrew);
    /// assert_eq!(CalendarPreferences::from(&locale!("und-AF")).resolved_algorithm(), CalendarAlgorithm::Persian);
    /// assert_eq!(CalendarPreferences::from(&locale!("und-US-u-rg-thxxxx")).resolved_algorithm(), CalendarAlgorithm::Buddhist);
    /// assert_eq!(
    ///     CalendarPreferences::from(&locale!("und-US-u-ca-islamic")).resolved_algorithm(),
    ///     CalendarAlgorithm::Hijri(Some(HijriCalendarAlgorithm::Civil))
    /// );
    /// # assert_eq!(CalendarPreferences::from(&"und-US-u-ca-islamic-rgsa".parse::<icu::locale::Locale>().unwrap()).resolved_algorithm(),
    /// #     CalendarAlgorithm::Hijri(Some(HijriCalendarAlgorithm::Civil))
    /// # );
    /// # assert_eq!(CalendarPreferences::from(&"und-US-u-ca-islamic-foo".parse::<icu::locale::Locale>().unwrap()).resolved_algorithm(),
    /// #     CalendarAlgorithm::Gregory
    /// # );
    /// # assert_eq!(CalendarPreferences::from(&"und-US-u-ca-hebrew-foo".parse::<icu::locale::Locale>().unwrap()).resolved_algorithm(),
    /// #     CalendarAlgorithm::Gregory
    /// # );
    /// ```
    pub fn resolved_algorithm(self) -> CalendarAlgorithm {
        use icu_locale_core::subtags::{region, Region};
        const AE: Region = region!("AE");
        const BH: Region = region!("BH");
        const KW: Region = region!("KW");
        const QA: Region = region!("QA");
        const SA: Region = region!("SA");
        const TH: Region = region!("TH");
        const AF: Region = region!("AF");
        const IR: Region = region!("IR");

        // This is tested to be consistent with CLDR in icu_provider_source::calendar::test_calendar_resolution
        match (
            self.calendar_algorithm,
            self.locale_preferences
                .to_data_locale_region_priority()
                .region,
        ) {
            (
                Some(CalendarAlgorithm::Hijri(None | Some(HijriCalendarAlgorithm::Rgsa))),
                Some(AE | BH | KW | QA | SA),
            ) => CalendarAlgorithm::Hijri(Some(HijriCalendarAlgorithm::Umalqura)),
            (Some(CalendarAlgorithm::Hijri(None | Some(HijriCalendarAlgorithm::Rgsa))), _) => {
                CalendarAlgorithm::Hijri(Some(HijriCalendarAlgorithm::Civil))
            }
            (Some(a), _) => a,
            (None, Some(TH)) => CalendarAlgorithm::Buddhist,
            (None, Some(AF | IR)) => CalendarAlgorithm::Persian,
            (None, _) => CalendarAlgorithm::Gregory,
        }
    }
}