Struct Table 

pub struct Table(/* private fields */);

A shared table handle.

Cloning a Table shares the same underlying storage, so identity is preserved. Use Table::new to build one and the insertion helpers to fill it.

Equality is by identity. Two Table handles are equal when they point at the same storage, matching Lua reference semantics. Contents are not compared.

The storage is private. Read contents through Table::get, Table::entries, or Table::with_entries, and write through push, set, and the meta setters.

Implementations

impl Table

pub fn new() -> Self

Create an empty table.

pub fn push(&self, v: Value)

Append a value to the array part at the next integer index.

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

Set key to value. Replaces an existing entry with an equal key.

pub fn border(&self) -> usize

The Lua # length: a border of the array part. This model uses the contiguous integer prefix from 1.

pub fn is_empty(&self) -> bool

True when the table has no entries.

pub fn id(&self) -> usize

Raw pointer used for identity comparison and hashing.

pub fn set_serialize_meta(&self, f: MetaFn)

Set the __serialize metamethod.

pub fn set_tostring_meta(&self, f: MetaFn)

Set the __tostring metamethod.

pub fn serialize_meta(&self) -> Option<MetaFn>

The __serialize metamethod, if set.

pub fn tostring_meta(&self) -> Option<MetaFn>

The __tostring metamethod, if set.

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

The value for key, if present. Compares keys with Key::same.

pub fn entries(&self) -> Vec<(Key, Value)>

A snapshot of the key/value pairs in insertion order.

This clones the entries. For a read-only pass without a clone, use Table::with_entries.

pub fn with_entries<R>(&self, f: impl FnOnce(&[(Key, Value)]) -> R) -> R

Run f over a borrow of the key/value pairs and return its result.

This avoids cloning the entries when a read pass is enough. The borrow is held for the duration of f, so f must not call back into methods that borrow the same table mutably.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a duplicate 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 PartialEq for Table

fn eq(&self, other: &Self) -> 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.