Enum cfgmap::CfgValue

pub enum CfgValue {
    Int(i64),
    Float(f64),
    Str(String),
    Bool(bool),
    Map(CfgMap),
    List(Vec<CfgValue>),
    Datetime(Datetime),
    Null,
}

Represents a value within a CfgMap

Variants

Int(i64)

Represents an integer value.

Float(f64)

Represents a float value.

Str(String)

Represents a string.

Bool(bool)

Represents a bool.

Map(CfgMap)

Represents a nested configuration map.

List(Vec<CfgValue>)

Represents a list of values. These values can have differing types.

Datetime(Datetime)

Represents a Datetime. Only available if using from_toml.

Null

Represents a null value. Only available if using from_json.

Methods

impl CfgValue

pub fn get(&self, key: &str) -> Option<&CfgValue>

Assumes the value is a CfgMap and attempts to execute .get() on it. Returns None if the value isn't a CfgMap, or for any reasons .get() may return None.

pub fn get_mut(&mut self, key: &str) -> Option<&mut CfgValue>

Assumes the value is a CfgMap and attempts to execute .get_mut() on it. Returns None if the value isn't a CfgMap, or for any reasons .get_mut() may return None.

pub fn generate_int(&self) -> Option<i64>

Generates an integer using the value, using rand. There are 3 total cases this function handles:

• Int(x): returns x
• List([Int(x)]): returns x
• List([Int(x),Int(y)]): returns an integer between x and y.
• Else: returns None.

Examples:

 
let num = Int(5);
let vnum = List(vec![Int(10)]);
let range = List(vec![Int(10), Int(20)]);
 
assert_eq!(5, num.generate_int().unwrap());
assert_eq!(10, vnum.generate_int().unwrap());
 
let generated = range.generate_int().unwrap();
assert!((generated >= 10) & (generated < 20));

pub fn generate_float(&self) -> Option<f64>

Generates an float using the value, using rand. There are 3 total cases this function handles:

• Float(x): returns x
• List([Float(x)]): returns x
• List([Float(x),Float(y)]): returns an integer between x and y.
• Else: returns None.

Examples:

 
let num = Float(5.0);
let vnum = List(vec![Float(10.0)]);
let range = List(vec![Float(10.0), Float(20.0)]);
 
assert_eq!(5.0, num.generate_float().unwrap());
assert_eq!(10.0, vnum.generate_float().unwrap());
 
let generated = range.generate_float().unwrap();
assert!((generated >= 10.0) & (generated < 20.0));

pub fn to_int(&self) -> Option<i64>

Returns the contents of the enum converted into an integer, if possible.

If the enum represents a float, it will be converted into an integer.

pub fn to_float(&self) -> Option<f64>

Returns the contents of the enum converted into a float, if possible.

If the enum represents an integer, it will be converted into a float.

pub fn is_int(&self) -> bool

Checks whether the enum is a CfgValue::Int.

pub fn is_float(&self) -> bool

Checks whether the enum is a CfgValue::Float.

pub fn is_str(&self) -> bool

Checks whether the enum is a CfgValue::Str.

pub fn is_bool(&self) -> bool

Checks whether the enum is a CfgValue::Bool.

pub fn is_map(&self) -> bool

Checks whether the enum is a CfgValue::Map.

pub fn is_list(&self) -> bool

Checks whether the enum is a CfgValue::List.

pub fn is_null(&self) -> bool

Checks whether the enum is a CfgValue::Null.

pub fn is_datetime(&self) -> bool

Checks whether the enum is a CfgValue::Datetime.

pub fn as_int(&self) -> Option<&i64>

Returns a reference to the _Int. Result is None if contents aren't a CfgValue::Int.

pub fn as_float(&self) -> Option<&f64>

Returns a reference to the _Float. Result is None if contents aren't a CfgValue::Float.

pub fn as_str(&self) -> Option<&String>

Returns a reference to the _Str. Result is None if contents aren't a CfgValue::Str.

pub fn as_bool(&self) -> Option<&bool>

Returns a reference to the _Bool. Result is None if contents aren't a CfgValue::Bool.

pub fn as_map(&self) -> Option<&CfgMap>

Returns a reference to the CfgMap. Result is None if contents aren't a CfgValue::Map.

pub fn as_list(&self) -> Option<&Vec<CfgValue>>

Returns a reference to the Vec<CfgValue>. Result is None if contents aren't a CfgValue::List.

pub fn as_int_mut(&mut self) -> Option<&mut i64>

Returns a reference to the _Int. Result is None if contents aren't a CfgValue::Int.

pub fn as_float_mut(&mut self) -> Option<&mut f64>

Returns a reference to the _Float. Result is None if contents aren't a CfgValue::Float.

pub fn as_str_mut(&mut self) -> Option<&mut String>

Returns a reference to the _Str. Result is None if contents aren't a CfgValue::Str.

pub fn as_bool_mut(&mut self) -> Option<&mut bool>

Returns a reference to the _Bool. Result is None if contents aren't a CfgValue::Bool.

pub fn as_map_mut(&mut self) -> Option<&mut CfgMap>

Returns a reference to the CfgMap. Result is None if contents aren't a CfgValue::Map.

pub fn as_list_mut(&mut self) -> Option<&mut Vec<CfgValue>>

Returns a reference to the Vec<CfgValue>. Result is None if contents aren't a CfgValue::List.

Trait Implementations

impl Checkable for CfgValue

fn check_that(&self, c: Condition) -> bool

Checks whether the object satisfies the condition passed as c.

impl Clone for CfgValue

fn clone(&self) -> CfgValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CfgValue

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

Formats the value using the given formatter.

impl<'_> From<&'_ str> for CfgValue

fn from(s: &str) -> Self

Performs the conversion.

impl From<CfgMap> for CfgValue

fn from(m: CfgMap) -> Self

Performs the conversion.

impl From<Option<CfgValue>> for CfgValue

fn from(opt: Option<CfgValue>) -> Self

Performs the conversion.

impl From<String> for CfgValue

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<CfgValue>> for CfgValue

fn from(l: Vec<CfgValue>) -> Self

Performs the conversion.

impl From<bool> for CfgValue

fn from(b: bool) -> Self

Performs the conversion.

impl From<f32> for CfgValue

fn from(f: f32) -> Self

Performs the conversion.

impl From<f64> for CfgValue

fn from(f: f64) -> Self

Performs the conversion.

impl From<i16> for CfgValue

fn from(i: i16) -> Self

Performs the conversion.

impl From<i32> for CfgValue

fn from(i: i32) -> Self

Performs the conversion.

impl From<i64> for CfgValue

fn from(i: i64) -> Self

Performs the conversion.

impl From<i8> for CfgValue

fn from(i: i8) -> Self

Performs the conversion.

impl From<u16> for CfgValue

fn from(i: u16) -> Self

Performs the conversion.

impl From<u32> for CfgValue

fn from(i: u32) -> Self

Performs the conversion.

impl From<u8> for CfgValue

fn from(i: u8) -> Self

Performs the conversion.

impl PartialEq<CfgValue> for CfgValue

fn eq(&self, other: &CfgValue) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for CfgValue