home-config

Crates.iohome-config
lib.rshome-config
version0.6.0
sourcesrc
created_at2022-03-05 17:01:14.638578
updated_at2022-11-01 05:58:20.84188
descriptionUse configuration file in the HOME directory
homepagehttps://github.com/wyhaya/home-config
repositoryhttps://github.com/wyhaya/home-config.git
max_upload_size
id544125
size14,802
(wyhaya)

documentation

README

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();
Commit count: 11

cargo fmt