Make an IxdtfParser type (#5736)

Based on #5735
unicode-org · Oct 29, 2024 · 34807e6 · 34807e6
1 parent b982957
commit 34807e6
Show file tree

Hide file tree

Showing 7 changed files with 302 additions and 256 deletions.
diff --git a/components/datetime/src/combo.rs b/components/datetime/src/combo.rs
@@ -19,7 +19,7 @@ use icu_provider::marker::NeverMarker;
 /// use icu::datetime::fieldset::{Combo, E, HM, L};
 /// use icu::datetime::DateTimeFormatter;
 /// use icu::locale::locale;
-/// use icu::timezone::CustomZonedDateTime;
+/// use icu::timezone::IxdtfParser;
 /// use writeable::assert_try_writeable_eq;
 ///
 /// let formatter = DateTimeFormatter::try_new(
@@ -28,7 +28,7 @@ use icu_provider::marker::NeverMarker;
 /// )
 /// .unwrap();
 ///
-/// let zdt = CustomZonedDateTime::try_location_only_from_str(
+/// let zdt = IxdtfParser::new().try_location_only_from_str(
 ///     "2024-10-18T15:44[America/Los_Angeles]",
 /// )
 /// .unwrap();
@@ -46,7 +46,7 @@ use icu_provider::marker::NeverMarker;
 /// use icu::datetime::fieldset::{Combo, E, HM, L};
 /// use icu::datetime::FixedCalendarDateTimeFormatter;
 /// use icu::locale::locale;
-/// use icu::timezone::CustomZonedDateTime;
+/// use icu::timezone::IxdtfParser;
 /// use writeable::assert_try_writeable_eq;
 ///
 /// let formatter = FixedCalendarDateTimeFormatter::try_new(
@@ -55,7 +55,7 @@ use icu_provider::marker::NeverMarker;
 /// )
 /// .unwrap();
 ///
-/// let zdt = CustomZonedDateTime::try_location_only_iso_from_str(
+/// let zdt = IxdtfParser::new().try_location_only_iso_from_str(
 ///     "2024-10-18T15:44[America/Los_Angeles]",
 /// )
 /// .unwrap()

diff --git a/components/datetime/src/fieldset.rs b/components/datetime/src/fieldset.rs
@@ -582,7 +582,7 @@ macro_rules! impl_zone_marker {
             ///
             /// ```
             /// use icu::calendar::{Date, Time};
-            /// use icu::timezone::{CustomZonedDateTime, TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
+            /// use icu::timezone::{TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
             /// use icu::calendar::Gregorian;
             /// use icu::datetime::FixedCalendarDateTimeFormatter;
             #[doc = concat!("use icu::datetime::fieldset::", stringify!($type), ";")]
@@ -738,7 +738,7 @@ macro_rules! impl_zoneddatetime_marker {
         ///
         /// ```
         /// use icu::calendar::{Date, Time};
-        /// use icu::timezone::{TimeZoneInfo, CustomZonedDateTime};
+        /// use icu::timezone::{TimeZoneInfo, IxdtfParser};
         /// use icu::datetime::DateTimeFormatter;
         #[doc = concat!("use icu::datetime::fieldset::", stringify!($type), ";")]
         /// use icu::locale::locale;
@@ -750,7 +750,7 @@ macro_rules! impl_zoneddatetime_marker {
         /// )
         /// .unwrap();
         ///
-        /// let mut dtz = CustomZonedDateTime::try_from_str("2024-05-17T15:47:50+01:00[Europe/London]").unwrap();
+        /// let mut dtz = IxdtfParser::new().try_from_str("2024-05-17T15:47:50+01:00[Europe/London]").unwrap();
         ///
         /// assert_try_writeable_eq!(
         ///     fmt.convert_and_format(&dtz),
@@ -762,7 +762,7 @@ macro_rules! impl_zoneddatetime_marker {
         ///
         /// ```
         /// use icu::calendar::{Date, Time};
-        /// use icu::timezone::{TimeZoneInfo, CustomZonedDateTime};
+        /// use icu::timezone::{TimeZoneInfo, IxdtfParser};
         /// use icu::calendar::Gregorian;
         /// use icu::datetime::FixedCalendarDateTimeFormatter;
         #[doc = concat!("use icu::datetime::fieldset::", stringify!($type), ";")]
@@ -775,7 +775,7 @@ macro_rules! impl_zoneddatetime_marker {
         /// )
         /// .unwrap();
         ///
-        /// let mut dtz = CustomZonedDateTime::try_from_str("2024-05-17T15:47:50+01:00[Europe/London]")
+        /// let mut dtz = IxdtfParser::new().try_from_str("2024-05-17T15:47:50+01:00[Europe/London]")
         ///     .unwrap()
         ///     .to_calendar(Gregorian);
         ///
@@ -981,7 +981,7 @@ impl_zone_marker!(
     ///
     /// ```
     /// use icu::calendar::{Date, Time};
-    /// use icu::timezone::{CustomZonedDateTime, TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
+    /// use icu::timezone::{IxdtfParser, TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
     /// use icu::calendar::Gregorian;
     /// use icu::datetime::FixedCalendarDateTimeFormatter;
     /// use icu::datetime::fieldset::Z;
@@ -1056,7 +1056,7 @@ impl_zone_marker!(
     ///
     /// ```
     /// use icu::calendar::{Date, Time};
-    /// use icu::timezone::{TimeZoneInfo, CustomZonedDateTime};
+    /// use icu::timezone::{TimeZoneInfo, IxdtfParser};
     /// use icu::calendar::Gregorian;
     /// use icu::datetime::DateTimeFormatter;
     /// use icu::datetime::fieldset::MD;
@@ -1079,7 +1079,7 @@ impl_zone_marker!(
     /// )
     /// .unwrap();
     ///
-    /// let dtz = CustomZonedDateTime::try_from_str("2024-09-17T15:47:50-05:00[America/Chicago]").unwrap();
+    /// let dtz = IxdtfParser::new().try_from_str("2024-09-17T15:47:50-05:00[America/Chicago]").unwrap();
     ///
     /// assert_try_writeable_eq!(
     ///     fmt.convert_and_format(&dtz),
@@ -1206,7 +1206,7 @@ impl_zone_marker!(
     ///
     /// ```
     /// use icu::calendar::{Date, Time};
-    /// use icu::timezone::{CustomZonedDateTime, TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
+    /// use icu::timezone::{IxdtfParser, TimeZoneBcp47Id, TimeZoneInfo, UtcOffset, ZoneVariant};
     /// use icu::calendar::Gregorian;
     /// use icu::datetime::FixedCalendarDateTimeFormatter;
     /// use icu::datetime::fieldset::V;
@@ -1278,7 +1278,7 @@ impl_zone_marker!(
     ///
     /// ```
     /// use icu::calendar::{Date, Time};
-    /// use icu::timezone::{TimeZoneInfo, CustomZonedDateTime};
+    /// use icu::timezone::{TimeZoneInfo, IxdtfParser};
     /// use icu::calendar::Gregorian;
     /// use icu::datetime::DateTimeFormatter;
     /// use icu::datetime::fieldset::MD;
@@ -1301,7 +1301,7 @@ impl_zone_marker!(
     /// )
     /// .unwrap();
     ///
-    /// let dtz = CustomZonedDateTime::try_from_str("2024-09-17T15:47:50-05:00[America/Chicago]").unwrap();
+    /// let dtz = IxdtfParser::new().try_from_str("2024-09-17T15:47:50-05:00[America/Chicago]").unwrap();
     ///
     /// assert_try_writeable_eq!(
     ///     fmt.convert_and_format(&dtz),

diff --git a/components/datetime/src/format/neo.rs b/components/datetime/src/format/neo.rs
@@ -326,7 +326,7 @@ size_test!(
 /// use icu::datetime::neo_pattern::DateTimePattern;
 /// use icu::datetime::neo_skeleton::NeoSkeleton;
 /// use icu::locale::locale;
-/// use icu::timezone::{TimeZoneInfo, CustomZonedDateTime};
+/// use icu::timezone::{TimeZoneInfo, IxdtfParser};
 /// use writeable::{Part, assert_try_writeable_parts_eq};
 ///
 /// // Create an instance that can format all fields (NeoSkeleton):
@@ -340,7 +340,7 @@ size_test!(
 /// // The pattern string contains lots of symbols including "E", "MMM", and "a",
 /// // but we did not load any data!
 ///
-/// let mut dtz = CustomZonedDateTime::try_from_str("2023-11-20T11:35:03+00:00[Europe/London]").unwrap().to_calendar(Gregorian);
+/// let mut dtz = IxdtfParser::new().try_from_str("2023-11-20T11:35:03+00:00[Europe/London]").unwrap().to_calendar(Gregorian);
 ///
 /// // Missing data is filled in on a best-effort basis, and an error is signaled.
 /// assert_try_writeable_parts_eq!(
@@ -967,15 +967,15 @@ impl<C: CldrCalendar, R: DateTimeNamesMarker> TypedDateTimeNames<C, R> {
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut zone_london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
     /// .zone;
-    /// let mut zone_london_summer = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_summer = IxdtfParser::new().try_from_str(
     ///     "2024-07-01T00:00:00+01:00[Europe/London]",
     /// )
     /// .unwrap()
@@ -1070,10 +1070,10 @@ impl<C: CldrCalendar, R: DateTimeNamesMarker> TypedDateTimeNames<C, R> {
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut zone_london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
@@ -1137,15 +1137,15 @@ impl<C: CldrCalendar, R: DateTimeNamesMarker> TypedDateTimeNames<C, R> {
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut zone_london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
     /// .zone;
-    /// let mut zone_london_summer = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_summer = IxdtfParser::new().try_from_str(
     ///     "2024-07-01T00:00:00+01:00[Europe/London]",
     /// )
     /// .unwrap()
@@ -1213,15 +1213,15 @@ impl<C: CldrCalendar, R: DateTimeNamesMarker> TypedDateTimeNames<C, R> {
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut zone_london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
     /// .zone;
-    /// let mut zone_london_summer = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_summer = IxdtfParser::new().try_from_str(
     ///     "2024-07-01T00:00:00+01:00[Europe/London]",
     /// )
     /// .unwrap()
@@ -1289,15 +1289,15 @@ impl<C: CldrCalendar, R: DateTimeNamesMarker> TypedDateTimeNames<C, R> {
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut zone_london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
     /// .zone;
-    /// let mut zone_london_summer = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_summer = IxdtfParser::new().try_from_str(
     ///     "2024-07-01T00:00:00+01:00[Europe/London]",
     /// )
     /// .unwrap()
@@ -1365,15 +1365,15 @@ impl<C: CldrCalendar, R: DateTimeNamesMarker> TypedDateTimeNames<C, R> {
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut zone_london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
     /// .zone;
-    /// let mut zone_london_summer = CustomZonedDateTime::try_from_str(
+    /// let mut zone_london_summer = IxdtfParser::new().try_from_str(
     ///     "2024-07-01T00:00:00+01:00[Europe/London]",
     /// )
     /// .unwrap()
@@ -2393,15 +2393,15 @@ where
     /// use icu::datetime::neo_skeleton::NeoTimeZoneSkeleton;
     /// use icu::datetime::TypedDateTimeNames;
     /// use icu::locale::locale;
-    /// use icu::timezone::CustomZonedDateTime;
+    /// use icu::timezone::IxdtfParser;
     /// use writeable::assert_try_writeable_eq;
     ///
-    /// let mut london_winter = CustomZonedDateTime::try_from_str(
+    /// let mut london_winter = IxdtfParser::new().try_from_str(
     ///     "2024-01-01T00:00:00+00:00[Europe/London]",
     /// )
     /// .unwrap()
     /// .to_calendar(Gregorian);
-    /// let mut london_summer = CustomZonedDateTime::try_from_str(
+    /// let mut london_summer = IxdtfParser::new().try_from_str(
     ///     "2024-07-01T00:00:00+01:00[Europe/London]",
     /// )
     /// .unwrap()

diff --git a/components/datetime/tests/mock.rs b/components/datetime/tests/mock.rs
@@ -5,7 +5,7 @@
 //! Some useful parsing functions for tests.
 
 use icu_calendar::{DateTime, Gregorian};
-use icu_timezone::{models, CustomZonedDateTime, TimeZoneInfo, ZoneVariant};
+use icu_timezone::{models, CustomZonedDateTime, IxdtfParser, TimeZoneInfo, ZoneVariant};
 
 /// Temporary function for parsing a `DateTime<Gregorian>`
 ///
@@ -58,10 +58,10 @@ pub fn parse_gregorian_from_str(input: &str) -> DateTime<Gregorian> {
 pub fn parse_zoned_gregorian_from_str(
     input: &str,
 ) -> CustomZonedDateTime<Gregorian, TimeZoneInfo<models::Full>> {
-    let iso_zdt = match CustomZonedDateTime::try_iso_from_str(input) {
+    let iso_zdt = match IxdtfParser::new().try_iso_from_str(input) {
         Ok(zdt) => zdt,
         Err(icu_timezone::ParseError::MismatchedTimeZoneFields) => {
-            match CustomZonedDateTime::try_loose_iso_from_str(input) {
+            match IxdtfParser::new().try_loose_iso_from_str(input) {
                 Ok(zdt) => {
                     CustomZonedDateTime {
                         date: zdt.date,