miniconf-parser 0.1.0

Pest-powered parser and CLI for the MiniConf configuration format.
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

#![deny(unsafe_code)]
#![warn(missing_docs)]

//! Pest-powered parser for the MiniConf configuration language.
//!
//! The crate exposes [`parse_str`] for one-shot parsing and re-exports the
//! [`Document`], [`Section`], and [`Value`] types for downstream consumers.

/// Abstract syntax tree types used to represent parsed documents.
pub mod ast;
/// Error types emitted by the parser.
pub mod error;
/// Low-level parser utilities and the generated pest machinery.
#[allow(missing_docs)]
pub mod parser;

pub use ast::{Document, Entry, Section, Value};
pub use error::{MiniConfError, ParseErrorKind};

/// Convenience function that parses `source` into a [`Document`].
pub fn parse_str(source: &str) -> Result<Document, MiniConfError> {
    parser::parse_document(source)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parses_minimal_document() {
        let doc = parse_str("key = value\n").expect("parsed");
        let root = doc.section("root").expect("root section");
        assert_eq!(root.entries[0].key, "key");
    }
}