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

//! Utilities for dumping data to an ICU4X filesystem tree.
//!
//! The `export` feature enables you to pull all data from some other data provider and persist it
//! in a blob of data to be read by [`StaticDataProvider`](crate::StaticDataProvider) at runtime.
//!
//! For a command-line user interface, see the `icu_datagen` crate.
//!
//! # Examples
//!
//! ```
//! use icu_provider::prelude::*;
//! use icu_provider::export::DataExporter;
//! use icu_provider::hello_world::*;
//! use icu_provider_blob::BlobDataProvider;
//! use icu_provider_blob::export::BlobExporter;
//! use std::borrow::Cow;
//! use std::io::Read;
//! use std::rc::Rc;
//!
//! let mut buffer: Vec<u8> = Vec::new();
//!
//! let payload = DataPayload::<HelloWorldV1Marker>::from_owned(
//!     HelloWorldV1 { message: Cow::Borrowed("Hi") }
//! );
//!
//! // Export something
//! {
//!     let mut exporter = BlobExporter::new_with_sink(Box::new(&mut buffer));
//!     exporter.put_payload(
//!         HelloWorldV1Marker::KEY,
//!         Default::default(),
//!         payload.clone().into_serializable(),
//!     ).expect("Should successfully export");
//!     exporter.close().expect("Should successfully dump to buffer");
//! }
//!
//! // Create a blob provider reading from the buffer
//! let provider = BlobDataProvider::new_from_rc_blob(buffer.into())
//!     .expect("Should successfully read from buffer");
//!
//! // Read the key from the filesystem and ensure it is as expected
//! let req = DataRequest {
//!     options: Default::default(),
//!     metadata: Default::default(),
//! };
//! let response: DataPayload<HelloWorldV1Marker> =
//!     provider.load_resource(&req).unwrap().take_payload().unwrap();
//!
//! assert_eq!(
//!     response.get(),
//!     payload.get(),
//! );
//! ```

mod blob_exporter;

pub use blob_exporter::BlobExporter;