tomldir 0.1.2

A lean, thread-safe TOML configuration loader focused on maps and flattening
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# tomldir

[![Crates.io](https://img.shields.io/crates/v/tomldir.svg)](https://crates.io/crates/tomldir)
[![Docs](https://docs.rs/tomldir/badge.svg)](https://docs.rs/tomldir)
[![CI](https://github.com/abhishekshree/tomldir/actions/workflows/ci.yml/badge.svg)](https://github.com/abhishekshree/tomldir/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

**tomldir** is a small, opinionated Rust crate for loading TOML configuration files into **map-based data structures**, optimized for runtime access, flattening, and configuration composition.

## Usage

Add to `Cargo.toml`:

```toml
[dependencies]
tomldir = "0.1"
# Optional: for order-preserving keys
indexmap = "2.0"
```

### Basic Usage

```rust
use tomldir::Config;

fn main() -> tomldir::Result<()> {
    let toml_data = r#"
        [database]
        host = "localhost"
        port = 5432
    "#;

    // Load into default HashMap
    let cfg = Config::from_toml(toml_data)?;
    
    // Thread-safe access (explicit cheap clone)
    let cfg = cfg.shared(); 

    assert_eq!(cfg.get_string("database.host"), Some("localhost"));
    Ok(())
}
```

### Advanced: Preserving Order with `IndexMap`

If you need to iterate over keys in the order they were defined (e.g., for help text generation or consistent output), use `IndexMap`.

```rust
use tomldir::{Config, Value};
use indexmap::IndexMap;

fn main() -> tomldir::Result<()> {
    let toml_data = r#"
        first = 1
        second = 2
    "#;

    // Specify storage type explicitly
    let cfg = Config::<IndexMap<String, Value>>::from_toml_with(toml_data)?;

    let keys: Vec<_> = cfg.flatten_into::<Vec<(String, String)>>()
        .into_iter()
        .map(|(k, _)| k)
        .collect();
    assert_eq!(keys, vec!["first", "second"]);
    
    Ok(())
}
```

You can get an iterator over all flattened key-value pairs as strings:

```rust
for (key, value) in cfg.flatten() {
    println!("{key} = {value}");
}
```

Or collect them into a specific map (like `HashMap<String, String>`) using `flatten_into()`:

```rust
let flat: HashMap<String, String> = cfg.flatten_into();
```

Or flatten into any custom type using `flatten_into()`:

```rust
use std::collections::BTreeMap;

// Flatten to BTreeMap (sorted keys)
let flat_sorted: BTreeMap<String, String> = cfg.flatten_into();

// Flatten to Vec
let flat_vec: Vec<(String, String)> = cfg.flatten_into();
```

## Features

* **TOML-only**: Built directly on `toml::Value`.
* **Map-first**: Stores data as `HashMap` by default, but swapable for `IndexMap` or `BTreeMap`.
* **Thread-safe**: Designed for `Arc` usage and concurrency.
* **Deterministic Flattening**: Nested tables become dot-separated keys.

## License

MIT