Struct LuaTableRef 

pub struct LuaTableRef { /* private fields */ }

A user-facing reference to a Lua table.

Holds the table in the VM registry so it won’t be garbage-collected. The registry entry is automatically released when this value is dropped.

!Send + !Sync — cannot be transferred across threads.

Example

let tbl = vm.create_table_ref(0, 4)?;
tbl.set("name", LuaValue::from("Alice"))?;
let name: String = tbl.get_as("name")?;
// tbl is automatically released here

Implementations

impl LuaTableRef

pub fn get(&self, key: &str) -> LuaResult<LuaValue>

Get a value by string key (raw access, no metamethods).

pub fn geti(&self, key: i64) -> LuaResult<LuaValue>

Get a value by integer key.

pub fn get_value(&self, key: &LuaValue) -> LuaResult<LuaValue>

Get a value by arbitrary LuaValue key.

pub fn get_as<T: FromLua>(&self, key: &str) -> LuaResult<T>

Get a value by string key and convert to a Rust type via FromLua.

pub fn get_typed<K: IntoLua, T: FromLua>(&self, key: K) -> LuaResult<T>

Get a value by arbitrary Rust-convertible key and convert it to T.

pub fn contains_key<K: IntoLua>(&self, key: K) -> LuaResult<bool>

Returns true if the table contains a non-nil value for the given key.

pub fn set(&self, key: &str, value: LuaValue) -> LuaResult<()>

Set a string-keyed value.

pub fn seti(&self, key: i64, value: LuaValue) -> LuaResult<()>

Set an integer-keyed value.

pub fn set_value(&self, key: LuaValue, value: LuaValue) -> LuaResult<()>

Set an arbitrary key-value pair.

pub fn set_typed<K: IntoLua, V: IntoLua>( &self, key: K, value: V, ) -> LuaResult<()>

Set an arbitrary key-value pair from Rust-convertible values.

pub fn pairs(&self) -> LuaResult<Vec<(LuaValue, LuaValue)>>

Get all key-value pairs (snapshot, no metamethods).

pub fn len(&self) -> LuaResult<usize>

Get the array length (equivalent to Lua’s #t).

pub fn is_empty(&self) -> LuaResult<bool>

pub fn push(&self, value: LuaValue) -> LuaResult<()>

Append a value to the array part (equivalent to table.insert).

pub fn push_typed<V: IntoLua>(&self, value: V) -> LuaResult<()>

Append a Rust value to the array part of the table.

pub fn pairs_typed<K: FromLua, V: FromLua>(&self) -> LuaResult<Vec<(K, V)>>

Convert all table pairs to typed Rust key-value pairs.

pub fn sequence_values<V: FromLua>(&self) -> LuaResult<Vec<V>>

Read contiguous sequence values from 1.. until a nil is encountered.

pub fn to_value(&self) -> LuaValue

Get the underlying LuaValue (retrieved from registry).

pub fn ref_id(&self) -> i32

Get the registry reference ID.

Trait Implementations

impl Clone for LuaTableRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaTableRef

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

Formats the value using the given formatter.