Struct LuaTable

pub struct LuaTable { /* private fields */ }

Represents a Lua table on the Lua stack.

Implementations

impl LuaTable

pub fn new(i: Index) -> LuaTable

Create a new LuaTable at the given index.

pub fn set_metatable(&self, context: &mut Context<'_>, meta: &LuaTable)

Set this table’s metatable.

Equivalent to the Lua setmetatable function

pub fn set(&self, context: &mut Context<'_>, key: &dyn ToLua, value: &dyn ToLua)

Set a value in this table May call the __newindex metamethod

Equivalent to table[key] = value in Lua

pub fn set_raw( &self, context: &mut Context<'_>, key: &dyn ToLua, value: &dyn ToLua, )

Set a value in this table without invoking metamethods

Equivalent to the Lua rawset function

pub fn get(&self, context: &mut Context<'_>, key: &dyn ToLua) -> LuaGeneric

Get a value from this table May call the __index metamethod

Equivalent to table[key] in Lua

pub fn get_raw(&self, context: &mut Context<'_>, key: &dyn ToLua) -> LuaGeneric

Get a value from this table without invoking metamethods

Equivalent to the Lua rawget function

pub fn get_typed<T: FromLua>( &self, context: &mut Context<'_>, key: &dyn ToLua, ) -> Option<T>

Get a value from this table as type T

pub fn len(&self, context: &mut Context<'_>) -> i64

Count the number of elements in this table as an array May call the __len metamethod

Equivalent to the Lua # operator

Panics

This method will panic if this table has a __len metamethod that does not return an integer

pub fn len_raw(&self, context: &mut Context<'_>) -> usize

Count the number of elements in this table as an array without calling the __len metamethod

Equivalent to the Lua rawlen function

pub fn iter_array<F>(&self, context: &mut Context<'_>, func: F)

where F: FnMut(Context<'_>, i64, LuaGeneric),

Iterate through every (i, value) pair where i is an integer and is continuous from 1 to this table’s length.

Similar to the Lua ipairs function

pub fn append(&self, context: &mut Context<'_>, value: &dyn ToLua)

Add an element to the end of the table

Equivalent to the Lua table.insert function

Trait Implementations

impl FromLua for LuaTable

fn from_lua(state: &mut State, index: Index) -> Option<LuaTable>

Converts the value on top of the stack of a Lua state to a value of type Option<Self>.

impl LuaStackable for LuaTable

fn get_pos(&self) -> Index

Get the position of this value on the stack

impl ToLua for LuaTable

fn to_lua(&self, state: &mut State)

Pushes a value of type Self onto the stack of a Lua state.