Rename timezone.rs to time_zone.rs (#574)

Closes #455

One final module review update for consistency. 😄

This should mark the end of the general module review.

---------

Co-authored-by: Manish Goregaokar <[email protected]>

Author: nekevss

src/builtins/core/duration/normalized.rs

@@ -5,7 +5,7 @@ use core::{cmp, num::NonZeroU128, ops::Add};
 use num_traits::AsPrimitive;
 
 use crate::{
-    builtins::core::{timezone::TimeZone, PlainDate, PlainDateTime},
+    builtins::core::{time_zone::TimeZone, PlainDate, PlainDateTime},
     iso::{IsoDate, IsoDateTime},
     options::{
         Disambiguation, Overflow, ResolvedRoundingOptions, RoundingIncrement, RoundingMode, Unit,
@@ -372,7 +372,7 @@ impl InternalDurationRecord {
         sign: Sign,
         dest_epoch_ns: i128,
         dt: &PlainDateTime,
-        tz: Option<(&TimeZone, &impl TimeZoneProvider)>, // ???
+        time_zone: Option<(&TimeZone, &impl TimeZoneProvider)>, // ???
         options: ResolvedRoundingOptions,
     ) -> TemporalResult<NudgeRecord> {
         // NOTE: r2 may never be used...need to test.
@@ -584,13 +584,13 @@ impl InternalDurationRecord {
         let end = IsoDateTime::new_unchecked(end.iso, dt.iso.time);
 
         // 12. Else,
-        let (start_epoch_ns, end_epoch_ns) = if let Some((tz, provider)) = tz {
+        let (start_epoch_ns, end_epoch_ns) = if let Some((time_zone, provider)) = time_zone {
             // a. Let startEpochNs be ? GetEpochNanosecondsFor(timeZone, startDateTime, compatible).
             // b. Let endEpochNs be ? GetEpochNanosecondsFor(timeZone, endDateTime, compatible).
             let start_epoch_ns =
-                tz.get_epoch_nanoseconds_for(start, Disambiguation::Compatible, provider)?;
+                time_zone.get_epoch_nanoseconds_for(start, Disambiguation::Compatible, provider)?;
             let end_epoch_ns =
-                tz.get_epoch_nanoseconds_for(end, Disambiguation::Compatible, provider)?;
+                time_zone.get_epoch_nanoseconds_for(end, Disambiguation::Compatible, provider)?;
             (start_epoch_ns.ns, end_epoch_ns.ns)
         // 11. If timeZoneRec is unset, then
         } else {
@@ -658,7 +658,7 @@ impl InternalDurationRecord {
         &self,
         sign: Sign,
         dt: &PlainDateTime,
-        tz: &TimeZone,
+        time_zone: &TimeZone,
         options: ResolvedRoundingOptions,
         provider: &impl TimeZoneProvider,
     ) -> TemporalResult<NudgeRecord> {
@@ -681,9 +681,11 @@ impl InternalDurationRecord {
         // 4. Let endDateTime be CombineISODateAndTimeRecord(endDate, isoDateTime.[[Time]]).
         let end_dt = IsoDateTime::new_unchecked(end_date, dt.iso.time);
         // 5. Let startEpochNs be ? GetEpochNanosecondsFor(timeZone, startDateTime, compatible).
-        let start = tz.get_epoch_nanoseconds_for(start_dt, Disambiguation::Compatible, provider)?;
+        let start =
+            time_zone.get_epoch_nanoseconds_for(start_dt, Disambiguation::Compatible, provider)?;
         // 6. Let endEpochNs be ? GetEpochNanosecondsFor(timeZone, endDateTime, compatible).
-        let end = tz.get_epoch_nanoseconds_for(end_dt, Disambiguation::Compatible, provider)?;
+        let end =
+            time_zone.get_epoch_nanoseconds_for(end_dt, Disambiguation::Compatible, provider)?;
         // 7. Let daySpan be TimeDurationFromEpochNanosecondsDifference(endEpochNs, startEpochNs).
         let day_span = TimeDuration::from_nanosecond_difference(end.ns.0, start.ns.0)?;
         // 8. Assert: TimeDurationSign(daySpan) = sign.
@@ -1012,19 +1014,19 @@ impl InternalDurationRecord {
         &self,
         dest_epoch_ns: i128,
         dt: &PlainDateTime,
-        tz: Option<(&TimeZone, &impl TimeZoneProvider)>,
+        time_zone: Option<(&TimeZone, &impl TimeZoneProvider)>,
         unit: Unit,
     ) -> TemporalResult<FiniteF64> {
         // 1. If IsCalendarUnit(unit) is true, or timeZone is not unset and unit is day, then
-        if unit.is_calendar_unit() || (tz.is_some() && unit == Unit::Day) {
+        if unit.is_calendar_unit() || (time_zone.is_some() && unit == Unit::Day) {
             // a. Let sign be InternalDurationSign(duration).
             let sign = self.sign();
             // b. Let record be ? NudgeToCalendarUnit(sign, duration, destEpochNs, isoDateTime, timeZone, calendar, 1, unit, trunc).
             let record = self.nudge_calendar_unit(
                 sign,
                 dest_epoch_ns,
                 dt,
-                tz,
+                time_zone,
                 ResolvedRoundingOptions {
                     largest_unit: unit,
                     smallest_unit: unit,

src/builtins/core/mod.rs

@@ -8,7 +8,7 @@
 
 pub mod calendar;
 pub mod duration;
-pub mod timezone;
+pub mod time_zone;
 
 mod instant;
 mod plain_date;

src/builtins/core/now.rs

@@ -5,7 +5,7 @@ use crate::TemporalResult;
 use crate::{host::HostHooks, provider::TimeZoneProvider};
 
 use super::{
-    calendar::Calendar, timezone::TimeZone, Instant, PlainDate, PlainDateTime, PlainTime,
+    calendar::Calendar, time_zone::TimeZone, Instant, PlainDate, PlainDateTime, PlainTime,
     ZonedDateTime,
 };
 

src/builtins/core/plain_date.rs

@@ -655,7 +655,7 @@ impl PlainDate {
     #[inline]
     pub fn to_zoned_date_time_with_provider(
         &self,
-        tz: TimeZone,
+        time_zone: TimeZone,
         plain_time: Option<PlainTime>,
         provider: &impl TimeZoneProvider,
     ) -> TemporalResult<ZonedDateTime> {
@@ -667,16 +667,16 @@ impl PlainDate {
             // c. If ISODateTimeWithinLimits(isoDateTime) is false, throw a RangeError exception.
             let result_iso = IsoDateTime::new(self.iso, time.iso)?;
             // d. Let epochNs be ? GetEpochNanosecondsFor(timeZone, isoDateTime, compatible).
-            tz.get_epoch_nanoseconds_for(result_iso, Disambiguation::Compatible, provider)?
+            time_zone.get_epoch_nanoseconds_for(result_iso, Disambiguation::Compatible, provider)?
         //  5. If temporalTime is undefined, then
         } else {
             // a. Let epochNs be ? GetStartOfDay(timeZone, temporalDate.[[ISODate]]).
-            tz.get_start_of_day(&self.iso, provider)?
+            time_zone.get_start_of_day(&self.iso, provider)?
         };
         //  7. Return ! CreateTemporalZonedDateTime(epochNs, timeZone, temporalDate.[[Calendar]]).
         ZonedDateTime::try_new_with_cached_offset(
             epoch_ns.ns.0,
-            tz,
+            time_zone,
             self.calendar.clone(),
             epoch_ns.offset,
         )
@@ -947,9 +947,9 @@ mod tests {
         use timezone_provider::tzif::FsTzdbProvider;
         let provider = &FsTzdbProvider::default();
         let date = PlainDate::from_str("2020-01-01").unwrap();
-        let tz = TimeZone::try_from_str_with_provider("UTC", provider).unwrap();
+        let time_zone = TimeZone::try_from_str_with_provider("UTC", provider).unwrap();
         let zdt = date
-            .to_zoned_date_time_with_provider(tz, None, provider)
+            .to_zoned_date_time_with_provider(time_zone, None, provider)
             .unwrap();
         assert_eq!(zdt.year(), 2020);
         assert_eq!(zdt.month(), 1);

src/builtins/core/timezone.rs renamed to src/builtins/core/time_zone.rs

@@ -12,7 +12,7 @@ use crate::{
         core::{
             calendar::Calendar,
             duration::normalized::{InternalDurationRecord, TimeDuration},
-            timezone::{TimeZone, UtcOffset},
+            time_zone::{TimeZone, UtcOffset},
             Duration, Instant, PlainDate, PlainDateTime, PlainTime,
         },
     },

src/builtins/core/zoned_date_time.rs

@@ -348,7 +348,7 @@ pub mod fields {
 // TODO: Should we be exporting MonthCode and UtcOffset here.
 pub use crate::builtins::{
     calendar::{Calendar, MonthCode},
-    core::timezone::{TimeZone, UtcOffset},
+    core::time_zone::{TimeZone, UtcOffset},
     Duration, Instant, PlainDate, PlainDateTime, PlainMonthDay, PlainTime, PlainYearMonth,
     ZonedDateTime,
 };

src/lib.rs

@@ -1,7 +1,7 @@
 //! RelativeTo rounding option
 
 use crate::builtins::core::zoned_date_time::interpret_isodatetime_offset;
-use crate::builtins::core::{calendar::Calendar, timezone::TimeZone, PlainDate, ZonedDateTime};
+use crate::builtins::core::{calendar::Calendar, time_zone::TimeZone, PlainDate, ZonedDateTime};
 use crate::iso::{IsoDate, IsoTime};
 use crate::options::{Disambiguation, OffsetDisambiguation, Overflow};
 use crate::parsers::{parse_date_time, parse_zoned_date_time};
@@ -65,7 +65,7 @@ impl RelativeTo {
         // iv. Set matchBehaviour to match-minutes.
         let mut match_minutes = true;
 
-        let timezone = TimeZone::from_time_zone_record(annotation.tz, provider)?;
+        let time_zone = TimeZone::from_time_zone_record(annotation.tz, provider)?;
 
         let (offset_nanos, is_exact) = result
             .offset
@@ -111,7 +111,7 @@ impl RelativeTo {
             time,
             is_exact,
             offset_nanos,
-            &timezone,
+            &time_zone,
             Disambiguation::Compatible,
             OffsetDisambiguation::Reject,
             match_minutes,
@@ -120,7 +120,7 @@ impl RelativeTo {
 
         Ok(ZonedDateTime::try_new_with_cached_offset(
             epoch_ns.ns.0,
-            timezone,
+            time_zone,
             calendar,
             epoch_ns.offset,
         )?

src/options/relative_to.rs

@@ -145,7 +145,7 @@ impl ParsedZonedDateTime {
         let annotation = parse_result.tz.temporal_unwrap()?;
 
         // e. Let timeZone be ? ToTemporalTimeZoneIdentifier(annotation).
-        let timezone = TimeZone::from_time_zone_record(annotation.tz, provider)?;
+        let time_zone = TimeZone::from_time_zone_record(annotation.tz, provider)?;
 
         // f. Let offsetString be result.[[TimeZone]].[[OffsetString]].
         let (offset, has_utc_designator) = match parse_result.offset {
@@ -185,7 +185,7 @@ impl ParsedZonedDateTime {
             has_utc_designator,
             match_minutes,
             offset,
-            timezone,
+            timezone: time_zone,
         })
     }
 }

src/parsed_intermediates.rs

@@ -12,9 +12,9 @@ use ixdtf::{
 };
 use writeable::{impl_display_with_writeable, LengthHint, Writeable};
 
-mod timezone;
+mod time_zone;
 
-pub(crate) use timezone::{parse_allowed_timezone_formats, parse_identifier};
+pub(crate) use time_zone::{parse_allowed_timezone_formats, parse_identifier};
 
 // TODO: Move `Writeable` functionality to `ixdtf` crate