Struct lucia_lang::objects::Table

pub struct Table {
    pub array: Vec<(Value, Value)>,
    pub mapping: IndexMap<Value, Value>,
    pub metatable: Value,
}

The table implement.

Fields

array: Vec<(Value, Value)>

mapping: IndexMap<Value, Value>

metatable: Value

Implementations

impl Table

pub fn new() -> Self

Creates an empty Table.

The table is initially created with a capacity of 0, so it will not allocate until it is first inserted into.

pub fn iter(&self) -> Iter<'_>

Return an iterator over the key-value pairs of the table, in their order.

pub fn iter_mut(&mut self) -> IterMut<'_>

Return an iterator over the key-value pairs of the table, in their order.

pub fn keys(&self) -> Keys<'_>

Return an iterator over the keys of the table, in their order.

pub fn into_keys(self) -> IntoKeys

Return an owning iterator over the keys of the table, in their order.

pub fn values(&self) -> Values<'_>

Return an iterator over the values of the table, in their order.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Return an iterator over mutable references to the values of the table, in their order.

pub fn into_values(self) -> IntoValues

Return an owning iterator over the values of the table, in their order.

pub fn len(&self) -> usize

Return the number of key-value pairs in the table.

Computes in O(1) time.

pub fn is_empty(&self) -> bool

Returns true if the table contains no elements.

Computes in O(1) time.

pub fn clear(&mut self)

Remove all key-value pairs in the table, while preserving its capacity.

Computes in O(n) time.

pub fn get_index(&self, index: usize) -> Option<(&Value, &Value)>

Get a key-value pair by index.

Valid indices are 0 <= index < self.len().

Computes in O(1) time.

pub fn get_index_mut( &mut self, index: usize ) -> Option<(&mut Value, &mut Value)>

Get a key-value pair by index.

Valid indices are 0 <= index < self.len().

Computes in O(1) time.

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

Return a reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

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

Return a mutable reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn set(&mut self, key: &Value, value: Value)

Insert a key-value pair in the table.

Computes in O(1) time (amortized average).

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl Display for Table

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

Formats the value using the given formatter.

impl Extend<(Value, Value)> for Table

fn extend<T: IntoIterator<Item = (Value, Value)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Value> for Table

fn extend<T: IntoIterator<Item = Value>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<const N: usize> From<[(Value, Value); N]> for Table

fn from(arr: [(Value, Value); N]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[Value; N]> for Table

fn from(arr: [Value; N]) -> Self

Converts to this type from the input type.

impl FromIterator<(Value, Value)> for Table

fn from_iter<T: IntoIterator<Item = (Value, Value)>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for Table

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl Index<&Value> for Table

type Output = Value

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Table

type Item = (&'a Value, &'a Value)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Table

type Item = (&'a Value, &'a mut Value)

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Table

type Item = (Value, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Table> for Table

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Trace for Table

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn marked(&self) -> bool

Is this object marked.

impl Eq for Table

impl StructuralEq for Table

impl StructuralPartialEq for Table