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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

/*!
# Rust-ConfigParser [![CI](https://github.com/Basicprogrammer10/Rust-ConfigParser/actions/workflows/main.yml/badge.svg)](https://github.com/Basicprogrammer10/Rust-ConfigParser/actions/workflows/main.yml) ![Crates.io](https://img.shields.io/crates/d/simple_config_parser) ![Lines of code](https://img.shields.io/tokei/lines/github/Basicprogrammer10/Rust-ConfigParser)
⚙ Very simple config parsing lib for rust!

I made this because I just needed a simple config parser for one of my projects and wanted to learn how to make a rust crate. Hopefully you will find it useful as well. :P

## 💠 Install

Just add the following to your `Cargo.toml`:
```toml
[dependencies]
simple_config_parser = "1.0.0"
```

## 📀 Quick Start

This config parser is made for use with a simplified version of an ini file. There are no sections and currently no Escape character support.
```ini
; This is a comment
# This is also a comment
hello = World
rust = Is great
test = "TEST"
```

## 🐳 Why

There are already a few config parsers out there for rust so why use this one?

There are a few reasons:
- It's super simple to use
- Its faster then some other popular config parsers (by only a few hundred Nano seconds but still)
- It's code is easy to understand (For me at least)
- It would make me happy (:P)

## 💥 Examples

Create a new config from text and a file.
```rust
// Import Lib
use simple_config_parser::Config;

// Create a new config and parse text
let cfg = Config::new()
    .text("hello = world")
    .unwrap();

// Create a new config from a file
let cfg2 = Config::new()
    .file("config.cfg")
    .unwrap();
```

Get a value from a config.
```rust
// Import Lib
use simple_config_parser::Config;

// Create a new config with no file
let cfg = Config::new()
    .text("hello = World\nrust = Is great")
    .unwrap();

// Get a value from the config (As a string)
println!("Hello, {}", cfg.get_str("hello").unwrap());
```

Get value from a config as any type that implements FromStr.
```rust
// Import Lib
use simple_config_parser::Config;

// Create a new config with no file
let mut cfg = Config::new()
    .text("hello = true\nrust = 15\npi = 3.1415926535")
    .unwrap();

// Get a value from the config as bool
assert_eq!(cfg.get::<bool>("hello").unwrap(), true);

// Get a value from the config as int
assert_eq!(cfg.get::<i32>("rust").unwrap(), 15);

// Get a value from the config as float
assert_eq!(cfg.get::<f32>("pi").unwrap(), 3.1415926535);
```
*/

#![warn(missing_docs)]

mod config;
pub use config::{Config, ConfigError};