Enum Value

Source

pub enum Value {
    Bool(bool),
    Int(i64),
    Uint(u64),
    BigInt(BigInt),
    Float(f64),
    Str(String),
    Inst(DateTime<Utc>),
    Dur(TimeDelta),
    UUID([u8; 16]),
    Arr(Vec<Value>),
    Map(Box<HashMap<Key, Value>>),
    UnitVar(String),
}

Expand description

type representing a structom value.

Values are wrappers that represent any structom value, builtin or user defined.

they can be created manually or from source or binary, manipulated or converted to native types, and stringified or serialized.

§api

Value can be created through different forms

// manually
Value::from(1) // => Uint(1)

// from source
parse("1", &ParseOptions::default(), &VoidProvider{}); // => Uint(1)

// from binary
decode(&[0, 16, 1], &VoidProvider{}); // => Uint(1)

Value has different methods for manipulation its value.

let value = Value::Uint(1);

// test type
value.is_uint(); // => true

// get ref to inner value
value.as_uint(); // => Some(1)

// compare inner value
value == 1; // => true

// index for array and map
Value::from(vec![1, 2, 3])[1] // => Uint(2)

Value can be transformed into other forms.

let value = Value::Uint(1);

// convert to native type
value.cast<u64>(); // => Ok(1)

// stringify into object notation
stringify(value, &StringifyOptions::default()); // => "1"

// encode into binary
encode(value); // => [0, 16, 1]

§representation

builtin types are represented through their respective variant.

structs are represented through the Map variant containing the struct fields.

enums are represented by the UnitVar case it is unit variant.
else they are represented by a Map variant containing the fields, with a special key Key::enum_variant_key() storing the variant name.

for metadata wrapped types, they are represented by a Map variant containing the metadata with their values, with special keys: Key::has_meta_key() of value true and Key::inner_key() containing the wrapped value.

Variants§

§

Bool(bool)

boolean value, types: bool.

§

Int(i64)

signed integer value, types: i8, i16, i32, i64 vint.

§

Uint(u64)

unsigned integer value, types: u8, u16, u32, u64 vuint.

§

BigInt(BigInt)

big integer value, types: bint.

§

Float(f64)

floating point value, types: f32, f64

§

Str(String)

string value, types: str.

§

Inst(DateTime<Utc>)

instance value, types: inst, instN.

§

Dur(TimeDelta)

duration value, types: dur.

§

UUID([u8; 16])

uuid value, types: uuid.

§

Arr(Vec<Value>)

array value, types: arr.

§

Map(Box<HashMap<Key, Value>>)

map value, types: map, structs, enums with fields.

§

UnitVar(String)

unit variant enum, types: enum.

Enum Value Copy item path

§api

§representation

Variants§

Bool(bool)

Int(i64)

Uint(u64)

BigInt(BigInt)

Float(f64)

Str(String)

Inst(DateTime<Utc>)

Dur(TimeDelta)

UUID([u8; 16])

Arr(Vec<Value>)

Map(Box<HashMap<Key, Value>>)

UnitVar(String)

Implementations§

impl Value

pub fn is_bool(&self) -> bool

pub fn is_uint(&self) -> bool

pub fn is_int(&self) -> bool

pub fn is_str(&self) -> bool

pub fn is_bigint(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_inst(&self) -> bool

pub fn is_dur(&self) -> bool

pub fn is_uuid(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_map(&self) -> bool

pub fn is_unit_variant(&self) -> bool

pub fn is_enum(&self) -> bool

pub fn has_meta(&self) -> bool

impl Value

pub fn into_key(self) -> Option<Key>

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

pub fn inner(&self) -> &Value

pub fn inner_mut(&mut self) -> &mut Value

pub fn into_inner(self) -> Value

impl Value

pub fn map_from<K: Into<Key>, V: Into<Value>, I: IntoIterator<Item = (K, V)>>( iter: I, ) -> Value

impl Value

pub fn cast<T>(self) -> Option<T>where Value: TryInto<T>,

impl Value

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

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

pub fn as_uint(&self) -> Option<u64>

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

pub fn as_uuid(&self) -> Option<[u8; 16]>

pub fn as_dur(&self) -> Option<TimeDelta>

pub fn as_inst(&self) -> Option<DateTime<Utc>>

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

pub fn as_slice(&self) -> Option<&[Value]>

pub fn as_bigint(&self) -> Option<&BigInt>

pub fn as_map(&self) -> Option<&HashMap<Key, Value>>

pub fn as_vec_mut(&mut self) -> Option<&mut Vec<Value>>

pub fn as_map_mut(&mut self) -> Option<&mut HashMap<Key, Value>>

impl Value

pub fn index_arr<I: SliceIndex<[Value]>>( &self, index: I, ) -> Option<&<I as SliceIndex<[Value]>>::Output>

pub fn index_arr_mut<I: SliceIndex<[Value]>>( &mut self, index: I, ) -> Option<&mut <I as SliceIndex<[Value]>>::Output>

pub fn index_map(&self, key: &Key) -> Option<&Value>

pub fn index_map_mut(&mut self, key: &Key) -> Option<&mut Value>

Trait Implementations§

impl Clone for Value

fn clone(&self) -> Value

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

impl Debug for Value

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

impl Default for Value

fn default() -> Self

impl Display for Value

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

impl From<&str> for Value

fn from(s: &str) -> Self

impl From<[u8; 16]> for Value

fn from(v: [u8; 16]) -> Self

impl From<BigInt> for Value

fn from(v: BigInt) -> Self

impl From<DateTime<Utc>> for Value

fn from(v: DateTime<Utc>) -> Self

impl<K: Into<Key>, V: Into<Value>> From<HashMap<K, V>> for Value

Enum Value

pub fn cast<T>(self) -> Option<T>
where Value: TryInto<T>,