config-file2 0.4.1

Extremely easy to read and write configuration file
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# config-file2


Extremely easy to load and store your configuration file!

## Usage


1. Add dependency:
   ```bash
   cargo add config-file2

   ```
2. Enable which format you want to use in features.
   - `all`
   - `toml` (enabled by default)
   - `json`
   - `xml`
   - `yaml`
   - [`ron`](https://github.com/ron-rs/ron)

Here's an example of how to use it with json and yaml format:

```toml
[dependencies]
config-file2 = { version = "0.4", features = ["json", "yaml"] }
```

## Examples


```rust, no_run
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().unwrap();
assert_eq!(config.host.as_str(), "example.com");
```

Another way to store a struct into a configuration file:

```rust, no_run
use config_file2::Storable;
use serde::{Serialize, Deserialize};
use std::path::{Path, PathBuf};

#[derive(Serialize)]

struct TestStorable {
    path: PathBuf,
}

impl Storable for TestStorable {
    fn path(&self) -> impl AsRef<Path> {
        &self.path
    }
}

TestStorable { path: PathBuf::from("/tmp/myconfig.toml") }.store().unwrap();
```

## more


```rust, ignore
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<()>;
```