chore: cleanup zoneinfo_rs crate (#674)

This PR does some general cleanup for the `zoneinfo_rs` crate. There are
no major code changes besides organizational changes and alteration to
module paths.

It primarily completes the following:

- Splits apart the types in the types module between rule, zone, and
shared.
- Adds some documentation to the general types
- Adds an unstable feature and flags zoneinfo's `tzif` support

The goal here is generally to clean up this crate for a 0.1.0 release.

Author: nekevss

Cargo.toml

@@ -30,7 +30,7 @@ exclude = [
 [workspace.dependencies]
 # Self
 temporal_rs = { version = "0.1.2", path = ".", default-features = false }
-timezone_provider = { version = "0.1.2", path = "./provider" }
+timezone_provider = { version = "0.1.2", path = "./provider", default-features = false }
 zoneinfo_rs = { version = "0.0.18", path = "./zoneinfo" }
 
 # Dependencies

provider/Cargo.toml

@@ -57,7 +57,7 @@ zerovec = { workspace = true, features = ["derive", "alloc"] }
 tinystr = { workspace = true, features = ["zerovec"] }
 
 # IANA dependency
-zoneinfo_rs = { workspace = true, features = ["std"], optional = true }
+zoneinfo_rs = { workspace = true, features = ["std", "unstable"], optional = true }
 
 # tzif dependency
 tzif = { workspace = true, optional = true }

zoneinfo/Cargo.toml

@@ -7,7 +7,6 @@ rust-version.workspace = true
 authors.workspace = true
 license.workspace = true
 repository.workspace = true
-readme.workspace = true
 exclude.workspace = true
 include = [
     "src/**/*",
@@ -19,6 +18,7 @@ include = [
 
 [features]
 std = []
+unstable = []
 
 [dependencies]
 hashbrown = "0.16.0"

zoneinfo/README.md

@@ -9,8 +9,9 @@ zoneinfo files.
 ```rust
 use std::path::Path;
 use zoneinfo_rs::{ZoneInfoData, ZoneInfoCompiler};
-// Below assumes we are in the parent directory of `tzdata`
+// Below assumes we are in the parent directory of `tzdata`.
 let zoneinfo_filepath = Path::new("./tzdata/");
+// Parse and then compile the files from the directory.
 let parsed_data = ZoneInfoData::from_zoneinfo_directory(zoneinfo_filepath)?;
 let _compiled_data = ZoneInfoCompiler::new(parsed_data).build();
 ```

zoneinfo/src/compiler.rs

@@ -6,6 +6,16 @@
 
 use alloc::collections::BTreeSet;
 use alloc::string::String;
+
+#[cfg(feature = "unstable")]
+use crate::tzif::TzifBlockV2;
+use crate::{
+    posix::PosixTimeZone,
+    types::{QualifiedTimeKind, Time},
+    zone::ZoneRecord,
+    ZoneInfoData,
+};
+
 use hashbrown::HashMap;
 
 #[derive(Debug, Clone, PartialEq)]
@@ -108,6 +118,7 @@ pub struct CompiledTransitions {
 //
 // I think I would prefer all of that live in the `tzif` crate, but that will
 // be a process to update. So implement it here, and then upstream it?
+#[cfg(feature = "unstable")]
 impl CompiledTransitions {
     pub fn to_v2_data_block(&self) -> TzifBlockV2 {
         TzifBlockV2::from_transition_data(self)
@@ -123,14 +134,6 @@ pub struct CompiledTransitionsMap {
 
 // ==== ZoneInfoCompiler build / compile methods ====
 
-use crate::{
-    posix::PosixTimeZone,
-    types::{QualifiedTimeKind, Time},
-    tzif::TzifBlockV2,
-    zone::ZoneRecord,
-    ZoneInfoData,
-};
-
 /// The compiler for turning `ZoneInfoData` into `CompiledTransitionsData`
 pub struct ZoneInfoCompiler {
     data: ZoneInfoData,

zoneinfo/src/lib.rs

@@ -54,9 +54,11 @@ pub mod parser;
 pub mod posix;
 pub mod rule;
 pub mod types;
-pub mod tzif;
 pub mod zone;
 
+#[cfg(feature = "unstable")]
+pub mod tzif;
+
 #[doc(inline)]
 pub use compiler::ZoneInfoCompiler;
 
@@ -67,6 +69,7 @@ use rule::Rules;
 use zone::ZoneRecord;
 
 /// Well-known zone info file
+#[doc(hidden)]
 pub const ZONEINFO_FILES: &[&str] = &[
     "africa",
     "antarctica",

zoneinfo/src/posix.rs

@@ -1,15 +1,22 @@
+//! POSIX time zone types and implementation
+//!
+//! For more information on POSIX time zones, see the [GNU docs][gnu-docs].
+//!
+//! [gnu-docs]: https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html
+
 use crate::{
     rule::{LastRules, Rule},
-    types::{DayOfMonth, Month, QualifiedTime, Sign, Time, WeekDay},
+    types::{
+        rule::{DayOfMonth, WeekDay},
+        Month, QualifiedTime, Sign, Time,
+    },
     utils::month_to_day,
     zone::ZoneEntry,
 };
 use alloc::string::String;
 use core::fmt::Write;
 
-/// The POSIX time zone designated by the [GNU documentation][gnu-docs]
-///
-/// [gnu-docs]: https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html
+/// A parsed POSIX time zone
 #[derive(Debug, PartialEq)]
 pub struct PosixTimeZone {
     pub abbr: PosixAbbreviation,

zoneinfo/src/rule.rs

@@ -8,7 +8,10 @@ use alloc::{borrow::ToOwned, string::String, vec, vec::Vec};
 
 use crate::{
     parser::{next_split, ContextParse, LineParseContext, ZoneInfoParseError},
-    types::{DayOfMonth, Month, QualifiedTime, Time, ToYear},
+    types::{
+        rule::{DayOfMonth, ToYear},
+        Month, QualifiedTime, Time,
+    },
     utils::{self, epoch_seconds_for_epoch_days},
 };
 
@@ -301,7 +304,7 @@ impl Rule {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::types::{Sign, WeekDay};
+    use crate::types::{rule::WeekDay, Sign};
 
     const TEST_DATA: [&str; 22] = [
         "Rule	Algeria	1916	only	-	Jun	14	23:00s	1:00	S",