keyvalues-parser

keyvalues-parser uses pest to parse VDF text v1 files to an untyped Rust structure to ease manipulation and navigation. The parser provides an untyped Vdf representation as well as a linear TokenStream

The library is primarily used in conjunction with keyvalues-serde which provides a more ergonomic (yet more limiting) means of dealing with VDF text.

Installation

Just add the library to your Cargo.toml

$ cargo add keyvalues-parser

Quickstart

const LOGIN_USERS_VDF: &str = r#"
"users"
{
    "12345678901234567"
    {
        "AccountName"        "ACCOUNT_NAME"
        "PersonaName"        "PERSONA_NAME"
        "RememberPassword"    "1"
        "MostRecent"        "1"
        "Timestamp"        "1234567890"
    }
}
"#;

fn main() -> keyvalues_parser::error::Result<()> {
    let vdf = keyvalues_parser::parse(LOGIN_USERS_VDF)?;
    assert_eq!(
        "12345678901234567",
        vdf.value.unwrap_obj().keys().next().unwrap(),
    );

    Ok(())
}

Limitations

VDF text is drastically underspecified. This leads to the following liberties being taken

• Not respecting the ordering of key-value pairs, where the pairs are stored in a BTreeMap that sorts the values based on the key
• Because of limitations in representing sequences, an empty Vec of values will be rendered as a missing keyvalue pair

serde support

Deserialize is implemented for a handful of traits with the caveat that sequences can be problematic when going through the self-describing serde API's. This is most commonly encountered when trying to serde(flatten) to something like an Obj where it will fail deserializing any field that's not a sequence (so most of them...).

Benchmarks

A set of basic benchmarks can be found in the benches directory

These just test timing and throughput for both parsing and rendering of a fairly typical VDF file

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.