https://github.com/connorslade/rust-configparser
⚙ Very simple config parsing lib for rust
https://github.com/connorslade/rust-configparser
ini ini-parser parser rust rust-crate
Last synced: 10 months ago
JSON representation
⚙ Very simple config parsing lib for rust
- Host: GitHub
- URL: https://github.com/connorslade/rust-configparser
- Owner: connorslade
- License: gpl-3.0
- Created: 2021-07-07T19:31:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-05T03:32:39.000Z (over 4 years ago)
- Last Synced: 2025-03-28T08:07:25.623Z (11 months ago)
- Topics: ini, ini-parser, parser, rust, rust-crate
- Language: Rust
- Homepage: https://crates.io/crates/simple_config_parser
- Size: 48.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust-ConfigParser [](https://github.com/Basicprogrammer10/Rust-ConfigParser/actions/workflows/main.yml)  
⚙ 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::("hello").unwrap(), true);
// Get a value from the config as int
assert_eq!(cfg.get::("rust").unwrap(), 15);
// Get a value from the config as float
assert_eq!(cfg.get::("pi").unwrap(), 3.1415926535);
```