Struct mlua::prelude::LuaTable [−][src]
pub struct LuaTable<'lua>(_);
Expand description
Handle to an internal Lua table.
Implementations
Sets a key-value pair in the table.
If the value is nil
, this will effectively remove the pair.
This might invoke the __newindex
metamethod. Use the raw_set
method if that is not
desired.
Examples
Export a value as a global to make it usable from Lua:
let globals = lua.globals(); globals.set("assertions", cfg!(debug_assertions))?; lua.load(r#" if assertions == true then -- ... elseif assertions == false then -- ... else error("assertions neither on nor off?") end "#).exec()?;
Gets the value associated to key
from the table.
If no value is associated to key
, returns the nil
value.
This might invoke the __index
metamethod. Use the raw_get
method if that is not
desired.
Examples
Query the version of the Lua interpreter:
let globals = lua.globals(); let version: String = globals.get("_VERSION")?; println!("Lua version: {}", version);
Checks whether the table contains a non-nil value for key
.
Compares two tables for equality.
Tables are compared by reference first.
If they are not primitively equals, then mlua will try to invoke the __eq
metamethod.
mlua will check self
first for the metamethod, then other
if not found.
Examples
Compare two tables using __eq
metamethod:
let table1 = lua.create_table()?; table1.set(1, "value")?; let table2 = lua.create_table()?; table2.set(2, "value")?; let always_equals_mt = lua.create_table()?; always_equals_mt.set("__eq", lua.create_function(|_, (_t1, _t2): (Table, Table)| Ok(true))?)?; table2.set_metatable(Some(always_equals_mt)); assert!(table1.equals(&table1.clone())?); assert!(table1.equals(&table2)?);
Sets a key-value pair without invoking metamethods.
Gets the value associated to key
without invoking metamethods.
Inserts element value at position idx
to the table, shifting up the elements from table[idx]
.
The worst case complexity is O(n), where n is the table length.
Removes a key from the table.
If key
is an integer, mlua shifts down the elements from table[key+1]
,
and erases element table[key]
. The complexity is O(n) in the worst case,
where n is the table length.
For other key types this is equivalent to setting table[key] = nil
.
Returns the result of the Lua #
operator.
This might invoke the __len
metamethod. Use the raw_len
method if that is not desired.
Returns the result of the Lua #
operator, without invoking the __len
metamethod.
Returns a reference to the metatable of this table, or None
if no metatable is set.
Unlike the getmetatable
Lua function, this method ignores the __metatable
field.
Sets or removes the metatable of this table.
If metatable
is None
, the metatable is removed (if no metatable is set, this does
nothing).
pub fn pairs<K: FromLua<'lua>, V: FromLua<'lua>>(self) -> TablePairs<'lua, K, V>ⓘNotable traits for TablePairs<'lua, K, V>
impl<'lua, K, V> Iterator for TablePairs<'lua, K, V> where
K: FromLua<'lua>,
V: FromLua<'lua>, type Item = Result<(K, V)>;
[src]
pub fn pairs<K: FromLua<'lua>, V: FromLua<'lua>>(self) -> TablePairs<'lua, K, V>ⓘNotable traits for TablePairs<'lua, K, V>
impl<'lua, K, V> Iterator for TablePairs<'lua, K, V> where
K: FromLua<'lua>,
V: FromLua<'lua>, type Item = Result<(K, V)>;
[src]Consume this table and return an iterator over the pairs of the table.
This works like the Lua pairs
function, but does not invoke the __pairs
metamethod.
The pairs are wrapped in a Result
, since they are lazily converted to K
and V
types.
Note
While this method consumes the Table
object, it can not prevent code from mutating the
table while the iteration is in progress. Refer to the Lua manual for information about
the consequences of such mutation.
Examples
Iterate over all globals:
let globals = lua.globals(); for pair in globals.pairs::<Value, Value>() { let (key, value) = pair?; // ... }
pub fn sequence_values<V: FromLua<'lua>>(self) -> TableSequence<'lua, V>ⓘNotable traits for TableSequence<'lua, V>
impl<'lua, V> Iterator for TableSequence<'lua, V> where
V: FromLua<'lua>, type Item = Result<V>;
[src]
pub fn sequence_values<V: FromLua<'lua>>(self) -> TableSequence<'lua, V>ⓘNotable traits for TableSequence<'lua, V>
impl<'lua, V> Iterator for TableSequence<'lua, V> where
V: FromLua<'lua>, type Item = Result<V>;
[src]Consume this table and return an iterator over all values in the sequence part of the table.
The iterator will yield all values t[1]
, t[2]
, and so on, until a nil
value is
encountered. This mirrors the behavior of Lua’s ipairs
function and will invoke the
__index
metamethod according to the usual rules. However, the deprecated __ipairs
metatable will not be called.
Just like pairs
, the values are wrapped in a Result
.
Note
While this method consumes the Table
object, it can not prevent code from mutating the
table while the iteration is in progress. Refer to the Lua manual for information about
the consequences of such mutation.
Examples
let my_table: Table = lua.load(r#" { [1] = 4, [2] = 5, [4] = 7, key = 2 } "#).eval()?; let expected = [4, 5]; for (&expected, got) in expected.iter().zip(my_table.sequence_values::<u32>()) { assert_eq!(expected, got?); }
pub fn raw_sequence_values<V: FromLua<'lua>>(self) -> TableSequence<'lua, V>ⓘNotable traits for TableSequence<'lua, V>
impl<'lua, V> Iterator for TableSequence<'lua, V> where
V: FromLua<'lua>, type Item = Result<V>;
[src]
pub fn raw_sequence_values<V: FromLua<'lua>>(self) -> TableSequence<'lua, V>ⓘNotable traits for TableSequence<'lua, V>
impl<'lua, V> Iterator for TableSequence<'lua, V> where
V: FromLua<'lua>, type Item = Result<V>;
[src]Consume this table and return an iterator over all values in the sequence part of the table.
Unlike the sequence_values
, does not invoke __index
metamethod when iterating.
Trait Implementations
fn call_method<K, A, R>(&self, key: K, args: A) -> Result<R> where
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua>,
[src]
fn call_method<K, A, R>(&self, key: K, args: A) -> Result<R> where
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua>,
[src]Gets the function associated to key
from the table and executes it,
passing the table itself along with args
as function arguments. Read more
fn call_function<K, A, R>(&self, key: K, args: A) -> Result<R> where
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua>,
[src]
fn call_function<K, A, R>(&self, key: K, args: A) -> Result<R> where
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua>,
[src]Gets the function associated to key
from the table and executes it,
passing args
as function arguments. Read more
fn call_async_method<'fut, K, A, R>(
&self,
key: K,
args: A
) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua> + 'fut,
[src]
fn call_async_method<'fut, K, A, R>(
&self,
key: K,
args: A
) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua> + 'fut,
[src]async
only.Gets the function associated to key
from the table and asynchronously executes it,
passing the table itself along with args
as function arguments and returning Future. Read more
fn call_async_function<'fut, K, A, R>(
&self,
key: K,
args: A
) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua> + 'fut,
[src]
fn call_async_function<'fut, K, A, R>(
&self,
key: K,
args: A
) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
K: ToLua<'lua>,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua> + 'fut,
[src]async
only.Gets the function associated to key
from the table and asynchronously executes it,
passing args
as function arguments and returning Future. Read more
Auto Trait Implementations
impl<'lua> !RefUnwindSafe for Table<'lua>
impl<'lua> !UnwindSafe for Table<'lua>
Blanket Implementations
Mutably borrows from an owned value. Read more