Configr
The dead easy way to use config files in your project
This will load a config.toml file if it exists, otherwise it will create the needed folders and the toml file.
It can either use the OS config directories which are as follows
- Linux:
$XDG_CONFIG_HOME/app-name/config.toml - Windows:
%APPDATA%/app-name/config.toml - Mac OS:
$HOME/Library/Application Support/app-name/config.toml
or a custom config directory
Usage
Add the following to your Cargo.toml
configr = "0.7.0"
or use cargo-edit with cargo add configr
then in your project add the following snippet
use configr::{Config, ConfigrDefault};
#[derive(ConfigrDefault, Deserialize, Serialize, Default)]
pub struct BotConfig {
bot_username: String,
client_id: String,
client_secret: String,
channel: String,
}
replacing BotConfig with your configuration struct
and then load you can load the config, usually at the start of the application with the load function to load from the system config directory
let config = BotConfig::load("bot app", true).unwrap(); // Will load from /home/USER/.config/bot-app/config.toml
or with the load_with_dir function to use a custom config directory
let config = BotConfig::load_with_dir("bot app", "$HOME").unwrap(); // Will load from /home/USER/bot-app/config.toml
Use ConfigrDefault if you want the config.toml to be populated with default values, based on Default implentation, or use Configr if you want it to be populated with empty fields with the correct names
Example of above BotConfig
With Configr
bot_username=
client_id=
client_secret=
channel=
and with ConfigrDefault
bot_username=""
client_id=""
client_secret=""
channel=""
Contributors
I am at the moment not accepting any contributions that don't close an issue.
If you find any problems, or edge cases, please do open an issue!
License
This project is licensed under the unlicense license.
8.2k Jan 5, 2023
43 Dec 12, 2022
17 Dec 13, 2021
9 May 12, 2023
2 Jul 23, 2022
4 Dec 1, 2022
6 Dec 9, 2022
4 Aug 4, 2023
219 Oct 10, 2023
2 Sep 14, 2022
85 Dec 14, 2022
10.7k Jan 2, 2023
4 Nov 23, 2023
4 May 9, 2023
11 Dec 30, 2022
29 Dec 15, 2022
169 Dec 25, 2022
6 Nov 9, 2023
7 Apr 25, 2024