Crate icu_datagen

icu_datagen is a library to generate data files that can be used in ICU4X data providers.

Data files can be generated either programmatically (i.e. in build.rs), or through a command-line utility.

Examples

build.rs

use icu_datagen::prelude::*;
use std::fs::File;

fn main() {
    icu_datagen::datagen(
        Some(&[langid!("de"), langid!("en-AU")]),
        &[icu::list::provider::AndListV1Marker::KEY],
        &SourceData::default(),
        vec![Out::Blob(Box::new(File::create("data.postcard").unwrap()))],
    )
    .unwrap();
}

Command line

The command line interface can be installed with the bin Cargo feature.

$ cargo install icu4x-datagen

Once the tool is installed, you can invoke it like this:

$ icu4x-datagen \
>    --keys all \
>    --locales de en-AU \
>    --format blob \
>    --out data.postcard

More details can be found by running --help.

Modules

prelude

A prelude for using the datagen API

syntax

Out::Fs serialization formats.

Structs

DatagenProvider

DataProvider backed by SourceData

SourceData

Bag of options for datagen source data.

Enums

CldrLocaleSubset

Specifies a variant of CLDR JSON

CollationHanDatabase

Specifies the collation Han database to use.

Out

The output format.

Functions

all_keys

List of all supported keys, except those that require the “experimental” feature on the icu crate.

all_keys_with_experimental

List of all supported keys, including those that require the “experimental” feature on the icu crate.

datagen

Runs ICU4X datagen.

is_missing_cldr_error

Identifies errors that are due to missing CLDR data.

is_missing_icuexport_error

Identifies errors that are due to missing ICU export data.

key

Parses a human-readable key identifier into a DataKey.

keys

Parses a list of human-readable key identifiers and returns a list of DataKeys.

keys_from_bin

Parses a compiled binary and returns a list of DataKeys used by it.

keys_from_file

Parses a file of human-readable key identifiers and returns a list of DataKeys.