Enum Value

pub enum Value<'a> {
    Str(Cow<'a, str>),
    Obj(Obj<'a>),
}

Enum representing all valid VDF values

VDF is composed of Keys and their respective Values where this represents the latter. A value is either going to be a Str(Cow<str>), or an Obj(Obj) that contains a list of keys and values.

let value_str = Value::Str(Cow::from("some text"));
let value_obj = Value::Obj(Obj::new());

Variants

Str(Cow<'a, str>)

Obj(Obj<'a>)

Implementations

impl<'a> Value<'a>

pub fn is_str(&self) -> bool

Returns if the current value is the Str variant

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

let value_str = Value::Str(Cow::default());
assert!(value_str.is_str());

pub fn is_obj(&self) -> bool

Returns if the current value is the Obj variant

use keyvalues_parser::{Obj, Value};

let value_obj = Value::Obj(Obj::default());
assert!(value_obj.is_obj());

pub fn get_str(&self) -> Option<&str>

Gets the inner &str if this is a Value::Str

let value = Value::Str(Cow::from("some text"));

if let Some(s) = value.get_str() {
    println!("value str: {}", s);
}

pub fn get_obj(&self) -> Option<&Obj<'_>>

Gets the inner &Obj if this value is a Value::Obj

let value = Value::Obj(Obj::new());

if let Some(obj) = value.get_obj() {
    println!("value obj: {:?}", obj);
}

pub fn get_mut_str(&mut self) -> Option<&mut Cow<'a, str>>

Gets the inner &mut str if this is a Value::Str

let mut value = Value::Str(Cow::from("some text"));
let mut inner_str = value.get_mut_str().unwrap();
inner_str.to_mut().make_ascii_uppercase();

assert_eq!(
    value,
    Value::Str(Cow::from("SOME TEXT"))
);

pub fn get_mut_obj(&mut self) -> Option<&mut Obj<'a>>

Gets the inner &mut Obj if this is a Value::Obj

let mut value = Value::Obj(Obj::new());
let mut inner_obj = value.get_mut_obj().unwrap();
inner_obj.insert(Cow::from("new key"), vec![]);

// Prints:
// Value::Obj({
//    "new key": [],
// })
println!("{:?}", value);

pub fn unwrap_str(self) -> Cow<'a, str>

Unwraps the Cow<str> from the Value::Str

Panics

If the variant was Value::Obj

Examples

use keyvalues_parser::Value;
use std::borrow::Cow;

let value = Value::Str(Cow::from("Sample text"));
assert_eq!(value.unwrap_str(), "Sample text");

use keyvalues_parser::{Value, Obj};

let value = Value::Obj(Obj::new());
value.unwrap_str(); // <-- panics

pub fn unwrap_obj(self) -> Obj<'a>

Unwraps the Obj from the Value::Obj

Panics

If the variant was Value::Str

Examples

use keyvalues_parser::{Obj, Value};

let value = Value::Obj(Obj::new());
assert_eq!(value.unwrap_obj(), Obj::new());

use keyvalues_parser::Value;
use std::borrow::Cow;

let value = Value::Str(Cow::from("D'Oh"));
value.unwrap_obj(); // <-- panics

pub fn expect_str(self, msg: &str) -> Cow<'a, str>

Refer to Value::unwrap_str. Same situation, but with a custom message

pub fn expect_obj(self, msg: &str) -> Obj<'a>

Refer to Value::unwrap_obj. Same situation, but with a custom message

Trait Implementations

impl<'a> Clone for Value<'a>

fn clone(&self) -> Value<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Value<'a>

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

Formats the value using the given formatter.

impl<'a> From<Pair<'a, Rule>> for Value<'a>

fn from(grammar_value: PestPair<'a, Rule>) -> Self

Converts to this type from the input type.

impl<'a> From<Pair<'a, Rule>> for Value<'a>

fn from(grammar_value: PestPair<'a, Rule>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Value<'a>

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<'a> Ord for Value<'a>

fn cmp(&self, other: &Value<'a>) -> 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<'a> PartialEq for Value<'a>

fn eq(&self, other: &Value<'a>) -> 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<'a> PartialOrd for Value<'a>

fn partial_cmp(&self, other: &Value<'a>) -> 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<'a> Eq for Value<'a>

impl<'a> StructuralPartialEq for Value<'a>