Struct Vdf 

pub struct Vdf<'text> {
    pub key: Key<'text>,
    pub value: Value<'text>,
}

A loosely typed representation of VDF text

Vdf is represented as a single Key mapped to a single Value

Parse

Vdfs will generally be created through the use of parse() or Parser::parse() which takes a string representing VDF text and attempts to parse it to a Vdf representation.

Mutate

From there you can manipulate/extract from the representation as desired by using the standard conventions on the internal types (plain old BTreeMaps, Vecs, and Cows all the way down)

Render

The Vdf can also be rendered back to its text form through its Display implementation

Example

// Parse
let vdf_text = r#"
"Outer Key"
{
    "Inner Key" "Inner Value"
    "Inner Key"
    {
    }
}
"#;
let mut parsed = keyvalues_parser::parse(vdf_text)?;

// Mutate: i.e. remove the last "Inner Key" pair
parsed
    .value
    .get_mut_obj()
    .unwrap()
    .get_mut("Inner Key")
    .unwrap()
    .pop();

// Render: prints
// "Outer Key"
// {
//     "Inner Key" "Inner Value"
// }
println!("{}", parsed);

Fields

key: Key<'text>

value: Value<'text>

Implementations

impl<'a> Vdf<'a>

pub fn parse(s: &'a str) -> Result<Self>

👎Deprecated since 0.2.4:

Please use parse().map(Vdf::from) instead

Attempts to parse VDF text to a Vdf

pub fn parse_raw(s: &'a str) -> Result<Self>

👎Deprecated since 0.2.4:

Please use Parser::new().literal_special_chars(true).parse().map(Vdf::from) instead

impl Vdf<'_>

pub fn render(&self, writer: &mut impl Write) -> Result<()>

pub fn render_raw(&self, writer: &mut impl Write) -> Result<()>

impl<'text> Vdf<'text>

pub fn new(key: Key<'text>, value: Value<'text>) -> Self

Creates a Vdf using a provided key and value

use keyvalues_parser::{Vdf, Value};
use std::borrow::Cow;

let vdf = Vdf::new(Cow::from("Much Key"), Value::Str(Cow::from("Such Wow")));
// prints
// "Much Key"  "Such Wow"
println!("{}", vdf);

pub fn into_owned(self) -> Vdf<'static>

Converts this Vdf into a fully owned variant

Internally a Vdf can reference the underlying text. This changes all of those references to be be allocated instead, allowing for easier ownership

fn expect_owned_vdf(text: &'_ str) -> keyvalues_parser::Vdf<'static> {
    keyvalues_parser::parse(text).unwrap().into_vdf().into_owned()
}

let vdf = expect_owned_vdf(
    r#"foo { bar {} bar "allocates for ownership" }"#
);
assert_eq!(
    vdf.value.unwrap_obj().get("bar").unwrap()[1].get_str().unwrap(),
    "allocates for ownership",
);

Trait Implementations

impl<'text> Clone for Vdf<'text>

fn clone(&self) -> Vdf<'text>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'text> Debug for Vdf<'text>

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

Formats the value using the given formatter.

impl Display for Vdf<'_>

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

Formats the value using the given formatter.

impl<'text> From<PartialVdf<'text>> for Vdf<'text>

fn from(partial: PartialVdf<'text>) -> Self

Converts to this type from the input type.

impl<'text> Hash for Vdf<'text>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'text> Ord for Vdf<'text>

fn cmp(&self, other: &Vdf<'text>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'text> PartialEq for Vdf<'text>

fn eq(&self, other: &Vdf<'text>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'text> PartialOrd for Vdf<'text>

fn partial_cmp(&self, other: &Vdf<'text>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'text> Eq for Vdf<'text>

impl<'text> StructuralPartialEq for Vdf<'text>