Enum Type

pub enum Type {
    Text(String),
    Switch(bool),
    Int(i32),
    Float(f32),
    Complex(HashMap<String, Type>),
    Array(Vec<Type>),
    None,
}

Generic type enum used to work with data inside a Settings

Only should be used when interacting with the result of a get_value.

use settingsfile::Type;
 
let settings = Settings::new(EmptyConfig{});
 
match settings.get_value("options") {
    Some(Type::Text(option)) => { }, // a single option selected
    Some(Type::Array(options)) => { }, // multiple options here,
    _ => { }, // probably not valid because options in this case are strings
}

Variants

Text(String)

Switch(bool)

Int(i32)

Float(f32)

Complex(HashMap<String, Type>)

Array(Vec<Type>)

None

Implementations

impl Type

pub fn is_text(&self) -> bool

pub fn is_switch(&self) -> bool

pub fn is_int(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_complex(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_none(&self) -> bool

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

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

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

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

pub fn to_complex(&self) -> Option<HashMap<String, Type>>

pub fn to_array(&self) -> Option<Vec<Type>>

pub fn to_string(&self) -> String

pub fn flatten(&self, parent_key: Option<String>) -> Type

Flattens the Type.

If the type is anything but a Type::Complex it just returns a copy of the original Type.

If the type is a Type::Complex it returns a 1D Complex, thus flattening it. This is usually used recursively to flatten an entire Settings

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Type

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Type

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

Formats the value using the given formatter.

impl PartialEq for Type

fn eq(&self, other: &Type) -> 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 Serialize for Type

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> SupportedType for &'a Type

fn wrap(&self) -> Type

Function to wrap the type into a Type

impl SupportedType for Type

fn wrap(&self) -> Type

Function to wrap the type into a Type

impl StructuralPartialEq for Type