xtri 0.1.1

A fast, memory-efficient radix tree (compressed trie) implementation in Rust with UTF-8 support
Documentation 
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

# xtri

[![Crates.io](https://img.shields.io/crates/v/xtri)](https://crates.io/crates/xtri)
[![Documentation](https://docs.rs/xtri/badge.svg)](https://docs.rs/xtri)
[![CI](https://github.com/oramasearch/xtri/actions/workflows/ci.yml/badge.svg)](https://github.com/oramasearch/xtri/actions/workflows/ci.yml)

A Rust library that implements a radix tree (compressed trie) data structure for efficient string storage and prefix-based searching.

## Features

- Generic radix tree structure `RadixTree<T>` supporting any value type
- Insert key-value pairs with automatic node compression and splitting
- Prefix-based search returning all matching key-value pairs (`search_prefix` and `search_iter`)
- Mutable value access through closures for safe modification (`mut_value`)
- Alphabetical ordering of search results
- Full UTF-8 support including emojis and international characters

## Usage

```rust
use xtri::{RadixTree, SearchMode};

fn main() {
    let mut tree = RadixTree::new();

    // Insert key-value pairs
    tree.insert("application", "main app");
    tree.insert("app", "short form");
    tree.insert("apple", "fruit");
    tree.insert("apply", "verb");
    tree.insert("approach", "method");
    tree.insert("appropriate", "suitable");

    // Search by prefix - returns all keys starting with "app"
    let iter = tree.search_iter("app", SearchMode::Prefix);
    for (key, value) in iter {
        println!("  {} -> {}", String::from_utf8_lossy(&key), value);
    }
    // Output:
    //   apple: fruit
    //   application: main app
    //   apply: verb

    // Update existing value or create a new one
    tree.mut_value("app", |value| {
        *value = Some("short form");
    });

    let iter = tree.search_iter("app", SearchMode::Exact);
    for (key, value) in iter {
        println!("  {} -> {}", String::from_utf8_lossy(&key), value);
    }
    // Output:
    //   app -> short form
}
```