#home #config-file

home-config

Use configuration file in the HOME directory

1 unstable release

0.6.0 Nov 1, 2022
0.5.0 Sep 14, 2022
0.4.0 May 24, 2022
0.3.0 May 23, 2022
0.1.0 Mar 5, 2022

#648 in Configuration

Download history 168/week @ 2024-07-29 48/week @ 2024-08-05 135/week @ 2024-08-12 84/week @ 2024-08-19 196/week @ 2024-08-26 124/week @ 2024-09-02 131/week @ 2024-09-09 123/week @ 2024-09-16 192/week @ 2024-09-23 114/week @ 2024-09-30 44/week @ 2024-10-07 83/week @ 2024-10-14 118/week @ 2024-10-21 163/week @ 2024-10-28 100/week @ 2024-11-04 61/week @ 2024-11-11

465 downloads per month
Used in 3 crates

MIT license

14KB
230 lines

home-config

Crates.io docs.rs LICENSE

Use configuration file in the HOME directory

Usage

use home_config::HomeConfig;

let config = HomeConfig::with_config_dir("app", "config");
// Linux: /home/name/.config/app/config
// macOS: /Users/name/.config/app/config
// Windows: C:\Users\name\.config\app\config

// Write
config.save("123456789").unwrap();

// Read
let data = config.read_to_string().unwrap();
// 123456789

Serde format support

home-config = { version = "*", features = ["json", "yaml", "toml", "hcl"] }

A JSON example:

use home_config::HomeConfig;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Default)]
struct People {
    name: String,
    age: u32,
}

let config = HomeConfig::with_file("test.json");
// Linux: /home/name/test.json
// macOS: /Users/name/test.json
// Windows: C:\Users\name\test.json

// Parse
let people = config.json::<People>().unwrap();
// people.name == "XiaoMing";
// people.age == 18;

// Save to file
config.save_json(&people).unwrap();

Dependencies

~0–1.5MB
~26K SLoC