DanielCoulbourne / figgy

A small Rust library for managing config files which supports heirarchical directories, defaults, and writing initial files

figgy

A small Rust library for managing config files which supports heirarchical directories, defaults, and writing initial files

Example:

~/.config/myapp/myapp.config.json OR ~/.myapp/myapp.config.json

{
    "api_key": "1234abcdef!@#$%",
    "api_version": 3
}

Your Rust program:

    use figgy::ConfigFile;
    use serde::{Deserialize, Serialize};

    #[derive(Serialize, Deserialize)]
    struct ApiKeysConfig {
        api_key: String,
        api_version: i16,
    }

    let config = ConfigFile::<ApiKeysConfig>::new("myapp.config.json")
            .directory("~/.config/myapp/")
            .directory("~/.myapp/")
            .read();

Default Configs

If you want a default configuration, you can set one with .default(). If you want to automatically write a config file if none is detected, use .create_file_if_not_found()

let config = ConfigFile::<ApiKeysConfig>::new("myapp.config.json")))
            .directory("~/.config/myapp/")
            .directory("~/.myapp/")
            .create_file_if_not_found()
            .default(ApiKeysConfig {
                api_key: "Super secret API key",
                api_version: 25,
            })
            .read();