UniProps-gen

UniProps is a blazing-fast, compile-time Unicode property generator for Rust. It generates highly optimized static tables to look up Unicode General Categories and Numeric Values with zero runtime allocation.

Note: This project is a complete evolution and fork of my previous project, dec-from-char. While dec-from-char focused solely on parsing decimal digits, UniProps generalizes this approach. It allows you to generate efficient data structures for any subset of Unicode data directly via build.rs.

Todo

Update metadata actions pipeline

🚀 Features

Unmatched Performance:
- Categories: Uses a Two-Level Trie (Index Table + Data Blocks) for true O(1) access.
Zero Runtime Allocation: All data is baked into your binary as standard static arrays.
Customizable: Generate only what you need. Filter by specific categories (e.g., only Nd digits) to drastically reduce your binary size.
Safe API: Generated code relies on safe wrappers around bounded unsafe lookups, ensuring maximum speed without bounds-checking overhead, while remaining 100% memory safe.

⚡ Benchmarks

Method	Operation	Time / iter	Notes
Rust Standard Library	`char::is_numeric()`	~7.66 ns	Standard `std` implementation
UniProps Digits	`get_digit_value(c)`	~6.15 ns	~20% Faster on mixed text
UniProps Categories	`Category::from_char(c)`	~5.22 ns	~32% Faster (O(1) Trie lookup)

📦 Installation

Add uniprops-gen to your [build-dependencies] in Cargo.toml.

[build-dependencies]
uniprops-gen = "0.3.0" # Use the latest version

🛠 Usage

1. Configure `build.rs`

Create a build.rs file in your project root. Use the builder to generate your tables into OUT_DIR.

// build.rs
use uniprops-gen::UnipropsBuilder;

fn main() {
    // Generate everything (Categories + Digits)
    UnipropsBuilder::new()
        .out_file("unicode_data.rs")
        .with_categories(true)
        .with_digits(true)
        .build();

    // OR: Generate a specialized table (e.g., only Decimal Numbers)
    UnipropsBuilder::new()
        .out_file("filtered_digits.rs")
        .filter(|record| record.general_category == "Nd")
        .build();
}

2. Include in `lib.rs`

Import the generated code using the include! macro.

// src/lib.rs

pub mod generated {
    // The file name must match what you set in build.rs
    include!(concat!(env!("OUT_DIR"), "/unicode_data.rs"));
}

fn main() {
    use generated::uniprops::{Category, get_digit_value};

    // 1. Fast Category Lookup
    assert_eq!(Category::from_char('A'), Some(Category::Lu)); // Letter, Uppercase
    assert_eq!(Category::from_char('🦀'), Some(Category::So)); // Symbol, Other

    // 2. Fast Digit Value Lookup
    assert_eq!(get_digit_value('9'), Some(9)); // ASCII
    assert_eq!(get_digit_value('٣'), Some(3)); // Arabic-Indic
    assert_eq!(get_digit_value('X'), None);
}

📄 License

This project is dual-licensed under either of:

at your option.

uniprops-gen 0.3.0