5 releases (1 stable)

1.0.0 Nov 5, 2021
0.1.6 Aug 3, 2021
0.1.5 Jul 8, 2021

#28 in Configuration

Download history 15/week @ 2021-08-15 3/week @ 2021-08-22 6/week @ 2021-08-29 15/week @ 2021-09-05 3/week @ 2021-09-12 13/week @ 2021-09-19 25/week @ 2021-10-03 29/week @ 2021-10-10 55/week @ 2021-10-17 2/week @ 2021-10-24 43/week @ 2021-10-31 56/week @ 2021-11-07 82/week @ 2021-11-14 48/week @ 2021-11-21 60/week @ 2021-11-28

256 downloads per month

GPL-3.0 license

18KB
99 lines

Rust-ConfigParser CI Crates.io Lines of code

⚙ 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:

[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.

; 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.

// 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.

// 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.

// 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);

No runtime deps

ܥa