Struct Parser 

pub struct Parser { /* private fields */ }

A configurable KeyValues parser allowing for adjusting settings before parsing

Implementations

impl Parser

pub const fn new() -> Self

Constructs a default parser

Currently this consists of:

Toggle	Description
Parser::literal_special_chars()	Whether to interpret \ in strings as the start of an escaped special character, or a literal \

pub const fn literal_special_chars(self, yes: bool) -> Self

Toggle how to interpret \ in strings

By default (false) the parser will interpret backslashes (\) in strings as the start of an escaped special character (e.g. \\ -> \, \" -> "). When true the parser will instead interpret backslashes (\) as a literal backslash. Commonly seen with windows-paths, for instance

pub fn parse<'text>(&self, vdf: &'text str) -> Result<PartialVdf<'text>>

Parse a KeyValues document to a loosely typed representation

Example

use keyvalues_parser::Parser;
let vdf = Parser::new()
    .literal_special_chars(true)
    .parse(r"InstallDir C:\You\Later")
    .unwrap();
assert_eq!(vdf.value.unwrap_str(), r"C:\You\Later");

Trait Implementations

impl Clone for Parser

fn clone(&self) -> Parser

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Parser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Parser

fn default() -> Parser

Returns the “default value” for a type.