Enum entity::Value

pub enum Value {
    List(Vec<Value>),
    Map(HashMap<String, Value>),
    Optional(Option<Box<Value>>),
    Primitive(PrimitiveValue),
    Text(String),
}

Represents either a primitive or complex value

Variants

List(Vec<Value>)

Map(HashMap<String, Value>)

Optional(Option<Box<Value>>)

Primitive(PrimitiveValue)

Text(String)

Implementations

impl Value

pub fn is_type(&self, r#type: ValueType) -> bool

Returns true if this value is of the specified type

pub fn to_type(&self) -> ValueType

Returns the type of this value

pub fn has_same_type(&self, other: &Value) -> bool

Returns true if this value and the other value are of the same type

pub fn is_complex(&self) -> bool

Returns true if not representing a primitive value

pub fn is_primitive(&self) -> bool

Returns true if representing a primitive value

pub fn to_primitive(&self) -> Option<PrimitiveValue>

Converts into underlying primitive value if representing one

pub fn to_primitive_type(&self) -> Option<PrimitiveValueType>

Converts into underlying primitive type if representing one

pub fn try_into_option<T: TryFrom<Value, Error = &'static str>>(
    self
) -> Result<Option<T>, &'static str>

Attempts to convert the value to an underlying option type, succeeding if Value is the Optional variant and the inner value can be converted to the specified type.

This is only needed due to a blanket impl in the standard library blocking the ability to implement TryFrom<Value> for Option<T>, which will be available some day once specialization is implemented:

https://github.com/rust-lang/rust/issues/31844

Trait Implementations

impl Clone for Value

pub fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Eq for Value

impl<'a> From<&'a Value> for ValueType

pub fn from(v: &'a Value) -> Self

Produces the type of the referenced value by recursively iterating through complex types, assuming that the first value in types like list represent the entire set, defaulting to a primitive unit if a complex value does not have any items

impl<'a> From<&'a str> for Value

pub fn from(s: &'a str) -> Self

Converts a str slice into a value by allocating a new string

impl<T: Into<Value>> From<BTreeMap<String, T>> for Value

pub fn from(map: BTreeMap<String, T>) -> Self

Converts a btree map of string keys and some value into a value map

impl<T: Into<Value>> From<BTreeSet<T>> for Value

pub fn from(list: BTreeSet<T>) -> Self

Converts a btree set of some value into a value list

impl<T: Into<Value>> From<BinaryHeap<T>> for Value

pub fn from(list: BinaryHeap<T>) -> Self

Converts a binary heap of some value into a value list

impl<T: Into<Value>> From<HashMap<String, T, RandomState>> for Value

pub fn from(map: HashMap<String, T>) -> Self

Converts a hashmap of string keys and some value into a value map

impl<T: Into<Value>> From<HashSet<T, RandomState>> for Value

pub fn from(list: HashSet<T>) -> Self

Converts a hashset of some value into a value list

impl<T: Into<Value>> From<LinkedList<T>> for Value

pub fn from(list: LinkedList<T>) -> Self

Converts a linked list of some value into a value list

impl<T: Into<Value>> From<Option<T>> for Value

pub fn from(maybe: Option<T>) -> Self

Converts an option of some value into an optional value

impl From<PrimitiveValue> for Value

pub fn from(v: PrimitiveValue) -> Self

Converts a primitive value into a value without any allocation

impl From<String> for Value

pub fn from(s: String) -> Self

Converts a string into a text value without any allocation

impl From<Value> for ValueType

pub fn from(value: Value) -> Self

Performs the conversion.

impl<T: Into<Value>> From<Vec<T, Global>> for Value

pub fn from(list: Vec<T>) -> Self

Converts a vec of some value into a value list

impl<T: Into<Value>> From<VecDeque<T>> for Value

pub fn from(list: VecDeque<T>) -> Self

Converts a vec deque of some value into a value list

impl From<bool> for Value

pub fn from(v: bool) -> Self

Performs the conversion.

impl From<char> for Value

pub fn from(v: char) -> Self

Performs the conversion.

impl From<f32> for Value

pub fn from(v: f32) -> Self

Performs the conversion.

impl From<f64> for Value

pub fn from(v: f64) -> Self

Performs the conversion.

impl From<i128> for Value

pub fn from(v: i128) -> Self

Performs the conversion.

impl From<i16> for Value

pub fn from(v: i16) -> Self

Performs the conversion.

impl From<i32> for Value

pub fn from(v: i32) -> Self

Performs the conversion.

impl From<i64> for Value

pub fn from(v: i64) -> Self

Performs the conversion.

impl From<i8> for Value

pub fn from(v: i8) -> Self

Performs the conversion.

impl From<isize> for Value

pub fn from(v: isize) -> Self

Performs the conversion.

impl From<u128> for Value

pub fn from(v: u128) -> Self

Performs the conversion.

impl From<u16> for Value

pub fn from(v: u16) -> Self

Performs the conversion.

impl From<u32> for Value

pub fn from(v: u32) -> Self

Performs the conversion.

impl From<u64> for Value

pub fn from(v: u64) -> Self

Performs the conversion.

impl From<u8> for Value

pub fn from(v: u8) -> Self

Performs the conversion.

impl From<usize> for Value

pub fn from(v: usize) -> Self

Performs the conversion.

impl Hash for Value

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Value> for Value

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

Compares two values of same type for equality, otherwise returns false

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Value> for Value

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Compares same variants for ordering, otherwise returns none

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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