Enum Value

pub enum Value {
    Float(f64),
    Int(i64),
    Str(String),
    KeyVal((Box<Value>, Box<Value>)),
    Array(Vec<Value>),
    Null,
}

Available on crate feature artemis only.

Represents a value in LUA table

Variants

Float(f64)

Float number

Int(i64)

Integer number

Str(String)

String value

KeyVal((Box<Value>, Box<Value>))

Key value pair

Array(Vec<Value>)

Array of values

Null

Null(nli) value

Implementations

impl Value

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

Returns a reference to the string if the value is a string, otherwise returns None.

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

Returns a string if the value is a string, otherwise returns None.

pub fn find_array(&self, key: &str) -> &Value

Find a nested array by key (first value of nested array). If the key is not found, it returns a reference to NULL.

Example

{
   {"save", text="test"},
}

for above array, calling find_array("save") will return the entire array {"save", text="test"}.

pub fn find_array_mut(&mut self, key: &str) -> &mut Value

Find a nested array by key (first value of nested array). If the key is not found, it creates a new array with the key and returns a mutable reference to it.

Example

{
   {"save", text="test"},
}

for above array, calling find_array_mut("save") will return a mutable reference to the array {"save", text="test"}.

pub fn is_array(&self) -> bool

Returns true if the value is an array.

pub fn is_str(&self) -> bool

Returns true if the value is a string.

pub fn is_kv(&self) -> bool

Returns true if the value is a key-value pair.

pub fn is_null(&self) -> bool

Returns true if the value is null.

pub fn kv_key(&self) -> Option<&Value>

Returns the key of a key-value pair if it exists, otherwise returns None.

pub fn kv_keys<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Value> + 'a>

Returns the keys in a lua table.

pub fn last_member(&self) -> &Value

Returns the last member of the array if it exists, otherwise returns a reference to NULL.

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

Returns a mutable reference to the last member of the array.

If the array is empty, it creates a new member with NULL and returns it. If the value is not an array, it converts it to an array with a single NULL member.

pub fn len(&self) -> usize

Returns the length of the array.

pub fn insert_member(&mut self, index: usize, value: Value)

Inserts a member at the specified index in the array.

If the index is out of bounds, it appends the value to the end of the array. If the value is not an array, it converts it to an array with a single member.

pub fn members<'a>(&'a self) -> Iter<'a>

Returns an iterator over the members of the array.

pub fn members_mut<'a>(&'a mut self) -> IterMut<'a>

Returns a mutable iterator over the members of the array.

pub fn new_array() -> Self

Creates a new empty array.

pub fn new_kv<K: Into<Value>, V: Into<Value>>(key: K, value: V) -> Self

Creates a new key-value pair.

pub fn push_member(&mut self, value: Value)

Pushes a member to the end of the array.

pub fn set_str<S: AsRef<str> + ?Sized>(&mut self, value: &S)

Sets the value to a string.

pub fn set_string<S: Into<String>>(&mut self, value: S)

Sets the value to a string.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(i: i64) -> Self

Converts to this type from the input type.

impl<'a> Index<&'a Box<Value>> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: &'a Box<Value>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, 'b> Index<&'b Key<'a>> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: &'b Key<'a>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> Index<&'a String> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: &'a String) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> Index<&'a Value> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: &'a Value) -> &Self::Output

Performs the indexing (container[index]) operation.

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

type Output = Value

The returned type after indexing.

fn index(&self, key: &'a str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> Index<Key<'a>> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: Key<'a>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<NumKey<f64>> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: NumKey<f64>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<NumKey<i64>> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: NumKey<i64>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<String> for Value

type Output = Value

The returned type after indexing.

fn index(&self, key: String) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Value

type Output = Value

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, 'b> IndexMut<&'b Key<'a>> for Value

fn index_mut(&mut self, key: &'b Key<'a>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IndexMut<&'a String> for Value

fn index_mut(&mut self, index: &'a String) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IndexMut<&'a Value> for Value

fn index_mut(&mut self, index: &'a Value) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

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

fn index_mut(&mut self, index: &'a str) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a> IndexMut<Key<'a>> for Value

fn index_mut(&mut self, key: Key<'a>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<NumKey<f64>> for Value

fn index_mut(&mut self, key: NumKey<f64>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<NumKey<i64>> for Value

fn index_mut(&mut self, key: NumKey<i64>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<String> for Value

fn index_mut(&mut self, index: String) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Value

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq<String> for Box<Value>

fn eq(&self, other: &String) -> 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 PartialEq<String> for Value

fn eq(&self, other: &String) -> 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 PartialEq<Value> for Box<Value>

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

fn eq(&self, other: &f64) -> 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 PartialEq<f64> for Box<Value>

fn eq(&self, other: &f64) -> 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 PartialEq<f64> for Value

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

fn eq(&self, other: &i64) -> 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 PartialEq<i64> for Box<Value>

fn eq(&self, other: &i64) -> 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 PartialEq<i64> for Value

fn eq(&self, other: &i64) -> 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 PartialEq<str> for Box<Value>

fn eq(&self, other: &str) -> 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 PartialEq<str> for Value

fn eq(&self, other: &str) -> 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 PartialEq for Value

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

fn partial_cmp(&self, other: &f64) -> 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 PartialOrd<f64> for Value

fn partial_cmp(&self, other: &f64) -> 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 PartialOrd<i64> for Box<Value>

fn partial_cmp(&self, other: &i64) -> 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 PartialOrd<i64> for Value

fn partial_cmp(&self, other: &i64) -> 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 StructuralPartialEq for Value