tomlconf 1.1.1

Automatically generate, read, and manage application-specific TOML configuration files simply, cleanly, and consistently.
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

# TomlConf

[
![Crates.io](https://img.shields.io/crates/v/tomlconf?logo=rust&style=for-the-badge&label=crate)
![Downloads](https://img.shields.io/crates/d/tomlconf?style=flat-square)
](https://crates.io/crates/tomlconf)  
[
![GitHub](https://img.shields.io/github/repo-size/yaulendil/tomlconf?logo=github&style=for-the-badge&label=repo)
](https://github.com/yaulendil/tomlconf)

[
![docs.rs](https://docs.rs/tomlconf/badge.svg?style=for-the-badge)
](https://docs.rs/tomlconf)

##### Manage TOML Configuration files simply, cleanly, and consistently.

TomlConf uses the [`directories`](https://crates.io/crates/directories) library to locate the appropriate place for application data in a cross-platform way, and populates that location with a default file included at compile-time.

All you need to do is define a struct that implements `serde::de::DeserializeOwned` (typically by way of `#[derive(Deserialize)]` for a struct that owns its data) and implement the `ConfigData` trait for it.
You can then use the constructors on the trait to create, load, and read the data from a file;
If you also derive `Serialize`, you can even save changes to the data back into the file.

# Example

```rust
#[derive(Deserialize)]
struct AppConfig {
    output: String,
    number: usize,
}

impl ConfigData for AppConfig {
    const DEFAULT: &'static str = include_str!("cfg_default.toml");
}


fn main() {
    let cfg: ConfigFile<AppConfig> = match AppConfig::setup(
        "com", // "Qualifier"; OSX-specific.
        "Cool Software LTD", // Organization name.
        "TextPrinter", // Application name.
        "config.toml", // Configuration file name.
    ) {
        Ok((msg, config)) => {
            //  This `msg` variable tells the user whether an existing config
            //      file was found, or whether a new one was created with the
            //      default values instead.
            eprintln!("{}", msg);
            config
        }
        Err(msg) => {
            eprintln!("Setup failed: {}", msg);
            std::process::exit(1);
        }
    };

    for i in 0..cfg.number {
        println!("{}: {}", i, &cfg.output);
    }
}
```