config-dirs

Crates.ioconfig-dirs
lib.rsconfig-dirs
version0.2.0
sourcesrc
created_at2024-06-16 21:11:29.421692
updated_at2024-10-27 00:09:00.421004
descriptionLoad a config file by trying out default config file locations
homepage
repositoryhttps://github.com/nitn3lav/config-dirs-rs
max_upload_size
id1273861
size16,914
(nitn3lav)

documentation

README

config-dirs

Load a config file by trying out default config file locations:

  • {NAME_SCREAMING_SNAKE_CASE}_CONFIG envitonment variable
  • ~/.config/{name}/config.toml
  • /etc/{name}/config.toml
  • /usr/local/etc/{name}/config.toml
  • ~/Library/Preferences/{name}/config.toml
  • /usr/local/etc/{name}/config.toml
use serde::{Deserialize, Serialize};

#[derive(Debug, Deserialize, Serialize)]
struct Config {}

let config: Config = config_dirs::load("my-app", toml::from_str).expect("Failed to load config");

The case conversion of name for the environment variable is done using convert_case::Case::ScreamingSnake.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in config-dirs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Commit count: 5

cargo fmt