3 releases
0.3.2 | Jul 28, 2024 |
---|---|
0.3.1 | Jul 20, 2024 |
0.3.0 | Jul 19, 2024 |
#380 in Configuration
45 downloads per month
Used in git-simple-encrypt
19KB
338 lines
config-file2
Extremely easy to load and store your configuration file!
Usage
- Add dependency:
cargo add config-file2
- Enable which format you want to use in features.
all
toml
(enabled by default)json
xml
yaml
ron
Here's an example of how to use it with json and yaml format:
[dependencies]
config-file2 = { version = "0.3", features = ["json", "yaml"] }
Examples
use config_file2::{LoadConfigFile, StoreConfigFile};
use serde::{Serialize, Deserialize};
#[derive(Serialize, Deserialize)]
struct Config {
host: String,
}
// store
Config { host: "example.com".into() }.store("/tmp/myconfig.toml").unwrap();
// load
let config = Config::load("/tmp/myconfig.toml").unwrap();
assert_eq!(config.host.as_str(), "example.com");
more functions
fn load_with_specific_format(path: impl AsRef<Path>, config_type: ConfigFormat) -> Result<Self>;
fn load_or_default(path: impl AsRef<Path>) -> Result<Self>;
fn store_with_specific_format(self, path: impl AsRef<Path>, config_type: ConfigFormat) -> Result<()>;
fn store_without_overwrite(self, path: impl AsRef<Path>) -> Result<()>;
Dependencies
~0.4–10MB
~117K SLoC