Rust library for parsing configuration files

Last update: Jan 5, 2022

Overview

configster

Rust library for parsing configuration files

Config file format

The 'option' can be any string with no whitespace.

arbitrary_option = false
max_users = 30

The value for an option following the equal sign may have "attributes" that are separated by a delimiter. The delimiter is specified when calling parse_file():

parse_file("./config_test.conf", ',')

option = Blue, light, shiny
# option = nothing, void, empty, commented_out

An option is not required to be followed by a value. It can be used to disable a default feature.

FeatureOff

API

Calling parse_file() will return a single vector containing a struct (OptionProperties) for each option line in the config file. The attributes for a value are stored in a vector within the "Value" struct.

#[derive(Debug, PartialEq)]
pub struct Value {
    pub primary: String,
    pub attributes: Vec<String>,
}

#[derive(Debug, PartialEq)]
pub struct OptionProperties {
    pub option: String,
    pub value: Value,
}

Example Code

use std::io;

fn main() -> Result<(), io::Error> {

    let config_vec = configster::parse_file("./config_test.conf", ',')?;

    for i in &config_vec {
        println!("Option:'{}' | value '{}'", i.option, i.value.primary);

        for j in &i.value.attributes {
            println!("attr:'{}`", j);
        }
        println!();
    }
    Ok(())
}

See docs.rs/configster/ for generated API documentation.

Contributing

See CONTRIBUTING.md

A parser combinator for parsing &[Token].

PickTok A parser combinator like nom but specialized in parsing &[Token]. It has similar combinators as nom, but also provides convenient parser gener

6 Feb 24, 2023

Parser for Object files define the geometry and other properties for objects in Wavefront's Advanced Visualizer.

format of the Rust library load locad blender obj file to Rust NDArray. cargo run test\t10k-images.idx3-ubyte A png file will be generated for the fi

1 Jan 3, 2022

A native Rust port of Google's robots.txt parser and matcher C++ library.

robotstxt A native Rust port of Google's robots.txt parser and matcher C++ library. Native Rust port, no third-part crate dependency Zero unsafe code

72 Dec 11, 2022

A parser combinator library for Rust

combine An implementation of parser combinators for Rust, inspired by the Haskell library Parsec. As in Parsec the parsers are LL(1) by default but th

1.1k Dec 28, 2022

A library to display rich (Markdown) snippets and texts in a rust terminal application

A CLI utilities library leveraging Markdown to format terminal rendering, allowing separation of structure, data and skin. Based on crossterm so works

614 Dec 29, 2022

xml-rs is an XML library for Rust programming language

xml-rs, an XML library for Rust Documentation xml-rs is an XML library for Rust programming language. It is heavily inspired by Java Streaming API for

417 Jan 3, 2023

The Simplest Parser Library (that works) in Rust

The Simplest Parser Library (TSPL) TSPL is the The Simplest Parser Library that works in Rust. Concept In pure functional languages like Haskell, a Pa

28 Mar 1, 2024

Rust parser combinator framework

nom, eating data byte by byte nom is a parser combinators library written in Rust. Its goal is to provide tools to build safe parsers without compromi

7.6k Jan 7, 2023

A fast monadic-style parser combinator designed to work on stable Rust.

Chomp Chomp is a fast monadic-style parser combinator library designed to work on stable Rust. It was written as the culmination of the experiments de

228 Oct 31, 2022

Comments

When "InvalidOption" is assigned, also show line number

I think it would be a worthwhile improvement if the line number were added to "InvalidOption", such as "InvalidOptionLnn" or "InvalidOptionLine_nn".

https://github.com/theimpossibleastronaut/configster/blob/96ab97d84ea3b222d88f0d48121fdf94ac08ae58/src/lib.rs#L139-L140

https://github.com/theimpossibleastronaut/configster/blob/96ab97d84ea3b222d88f0d48121fdf94ac08ae58/src/lib.rs#L95-L96
enhancement

opened by andy5995 0
Document the two public structures

These public structs should be documented

https://github.com/theimpossibleastronaut/configster/blob/96ab97d84ea3b222d88f0d48121fdf94ac08ae58/src/lib.rs#L5-L15
documentation

opened by andy5995 0

Releases(v0.1.1)

v0.1.1(Aug 5, 2020)
v0.1.1 released (2020-08-05)

When an invalid option is encountered, 'InvalidOption_on_Linexx' is assigned to the option (instead of 'InvalidOption').

Added get_ver() function. Returns a String containing the library version.

Added more docs to the README and the API.

Code cleanup

[]crates-url
Source code(tar.gz)
Source code(zip)
configster-0.1.1.crate(5.71 KB)
v0.1.0(Jul 31, 2020)

The first version of this library consists of one public function. See https://crates.io/crates/configster for information about adding this crate to your rust project, as well as the API documentation.

Thanks to the rust community (##rust on Freenode and the Rust Community Forum).

[]crates-url
Source code(tar.gz)
Source code(zip)
configster-0.1.0.crate(4.88 KB)

Owner

The Impossible Astronaut

A collection of developers working on some random sources that we like

GitHub

rbdt is a python library (written in rust) for parsing robots.txt files for large scale batch processing.

rbdt ?? ?? ?? ?? rbdt is a work in progress, currently being extracted out of another (private) project for the purpose of open sourcing and better so

0 Nov 9, 2021

Universal configuration library parser

LIBUCL Table of Contents generated with DocToc Introduction Basic structure Improvements to the json notation General syntax sugar Automatic arrays cr