Datagen API polish (#3951)

Author: robertbastian

provider/blob/Cargo.toml

@@ -31,7 +31,7 @@ log = { version = "0.4", optional = true }
 
 [dev-dependencies]
 icu_locid = { workspace = true, features = ["serde"] }
-icu_datagen = { workspace = true }
+icu_datagen = { workspace = true, features = ["networking"] }
 
 [features]
 std = ["icu_provider/std"]

provider/blob/src/export/mod.rs

@@ -19,9 +19,9 @@
 //!
 //! // Export something
 //! DatagenDriver::new()
-//!   .with_keys([icu_provider::hello_world::HelloWorldV1Marker::KEY])
-//!   .export(&DatagenProvider::latest_tested(), exporter)
-//!   .unwrap();
+//!     .with_keys([icu_provider::hello_world::HelloWorldV1Marker::KEY])
+//!     .export(&DatagenProvider::latest_tested(), exporter)
+//!     .unwrap();
 //!
 //! // communicate the blob to the client application (network, disk, etc.)
 //! ```
@@ -42,18 +42,10 @@
 //!     BlobDataProvider::try_new_from_blob(blob.into_boxed_slice())
 //!         .expect("Should successfully read from blob");
 //!
-//! // Read the key from the blob
-//! let response: DataPayload<HelloWorldV1Marker> = provider
-//!     .as_deserializing()
-//!     .load(DataRequest {
-//!         locale: &langid!("en").into(),
-//!         metadata: Default::default(),
-//!     })
-//!     .unwrap()
-//!     .take_payload()
-//!     .unwrap();
+//! // Use the provider as a `BufferProvider`
+//! let formatter = HelloWorldFormatter::try_new_with_buffer_provider(&provider, &langid!("en").into()).unwrap();
 //!
-//! assert_eq!(response.get().message, "Hello World");
+//! assert_eq!(formatter.format_to_string(), "Hello World");
 //! ```
 
 mod blob_exporter;

provider/datagen/Cargo.toml

@@ -101,11 +101,11 @@ postcard = "1"
 simple_logger = { version = "4.1.0", default-features = false }
 
 [features]
-default = ["bin", "use_wasm", "networking", "legacy_api", "rayon"]
-provider_baked = ["dep:crlify", "dep:databake", "dep:syn"]
-provider_blob = ["dep:icu_provider_blob"]
-provider_fs = ["dep:icu_provider_fs"]
-legacy_api = ["provider_fs", "provider_blob", "provider_baked"]
+default = ["bin", "use_wasm", "networking", "legacy_api", "rayon", "fs_exporter", "blob_exporter", "baked_exporter"]
+baked_exporter = ["dep:crlify", "dep:databake", "dep:syn"]
+blob_exporter = ["dep:icu_provider_blob"]
+fs_exporter = ["dep:icu_provider_fs"]
+legacy_api = ["fs_exporter", "blob_exporter", "baked_exporter"]
 bin = ["dep:clap", "dep:eyre", "dep:simple_logger"]
 rayon = ["dep:rayon"]
 # Use wasm for building codepointtries
@@ -124,6 +124,14 @@ icu_relativetime = ["dep:icu_relativetime"]
 icu_singlenumberformatter = ["dep:icu_singlenumberformatter"]
 icu_transliteration = ["dep:icu_transliteration", "dep:icu_transliterator_parser"]
 icu_unitsconversion = ["dep:icu_unitsconversion"]
+experimental_components = [
+    "icu_compactdecimal",
+    "icu_displaynames",
+    "icu_relativetime",
+    "icu_singlenumberformatter",
+    "icu_transliteration",
+    "icu_unitsconversion"
+]
 
 [[bin]]
 name = "icu4x-datagen"
@@ -133,7 +141,7 @@ required-features = ["bin"]
 [[test]]
 name = "make-testdata"
 path = "tests/make-testdata.rs"
-required-features = ["provider_fs", "use_wasm"]
+required-features = ["fs_exporter", "use_wasm"]
 
 [package.metadata.cargo-all-features]
 # We don't need working CPT builders for check

provider/datagen/README.md

@@ -9,20 +9,21 @@
 //! # Examples
 //!
 //! ```
-//! use icu_datagen::prelude::*;
 //! use icu_datagen::baked_exporter::*;
+//! use icu_datagen::prelude::*;
 //!
 //! let demo_path = std::env::temp_dir().join("icu4x_baked_demo");
 //! # let _ = std::fs::remove_dir_all(&demo_path);
 //!
 //! // Set up the exporter
-//! let mut exporter = BakedExporter::new(demo_path.clone(), Default::default()).unwrap();
+//! let mut exporter =
+//!     BakedExporter::new(demo_path.clone(), Default::default()).unwrap();
 //!
 //! // Export something
 //! DatagenDriver::new()
-//!   .with_keys([icu_provider::hello_world::HelloWorldV1Marker::KEY])
-//!   .export(&DatagenProvider::latest_tested(), exporter)
-//!   .unwrap();
+//!     .with_keys([icu_provider::hello_world::HelloWorldV1Marker::KEY])
+//!     .export(&DatagenProvider::latest_tested(), exporter)
+//!     .unwrap();
 //! #
 //! # let _ = std::fs::remove_dir_all(&demo_path);
 //! ```
@@ -51,21 +52,14 @@
 //!     #     }
 //!     #   }
 //!     # }
-//!     include!("/path/to/mod/");
+//!     include!("/path/to/mod.rs");
 //!     impl_data_provider!(super::MyDataProvider);
 //! }
 //!
 //! # fn main() {
-//! let response: DataPayload<HelloWorldV1Marker> = MyDataProvider
-//!     .load(DataRequest {
-//!         locale: &langid!("en").into(),
-//!         metadata: Default::default(),
-//!     })
-//!     .unwrap()
-//!     .take_payload()
-//!     .unwrap();
+//! let formatter = HelloWorldFormatter::try_new_unstable(&MyDataProvider, &langid!("en").into()).unwrap();
 //!
-//! assert_eq!(response.get().message, "Hello World");
+//! assert_eq!(formatter.format_to_string(), "Hello World");
 //! # }
 //! ```