superconf 0.4.3

A barebones configuration file made for low-dependency rust applications.
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

# superconf

A barebones configuration file made for low-dependency rust applications.

- [Blog post](https://ogriffiths.com/2020/experimentation-with-markup-languages)
- [Documentation](https://docs.rs/superconf)

## Usage

Add to your `Cargo.toml` file:

```toml
[dependancies]
superconf = "0.4"
```

## Examples

Default seperator (space ` `) demonstration:

```rust
use superconf;

let input = "my_key my_value";

println!("{:#?}", superconf::parse(input).unwrap());
```

Or if you'd like to use a custom seperator like `:` or `=`:

```rust
use superconf::parse_custom_sep;

let input_equal = "custom=seperator";
let input_colon = "second:string";

println!("Equals seperator: {:#?}", parse_custom_sep(input_equal, '=').unwrap());
println!("Colon seperator: {:#?}", parse_custom_sep(input_colon, ':').unwrap());
```

Here is a complete syntax demonstration:

```none
# comments are like this
# no seperators are allowed in keys or values
# comments can only be at the start of lines, no end of line comments here

# my_key is the key, my_value is the value
my_key the_value

# you can use seperators as plaintext, just have to be backslashed
your_path /home/user/Cool\ Path/x.txt
```

## Config Conventions

Some conventions commonly used for superconf files:

- The file naming scheme is `snake_case`
- Try to document each line with a comment
- If commented, space each config part with an empty line seperating it from
others. If it is undocumented, you may bunch all config parts together

## Motivations

### Original motivations for creating

Made this as a quick custom parser to challenge myself a bit and to use for a quick-n-dirty configuration format in the future. It's not the best file
format in the world but it gets the job done.

### Current/future motivations for maintaining

Maintaining: This library is now being used inside of my [ipeer](https://github.com/owez/ipeer) p2p implementation for all `.ipeer` files so maintaining this library is critical.