Struct Table

pub struct Table<'l>(/* private fields */);

Represents a lua table on the stack

Implementations

impl<'l> Table<'l>

pub fn getp<T>(&self, p: *const T) -> Result<ValRef<'_>>

Get value with a lightuserdata key, commonly is a function pointer

pub fn setp<T, V: ToLua>(&self, k: *const T, v: V) -> Result<()>

Set value with a lightuserdata key

pub fn reference<V: ToLua>(&self, v: V) -> Result<Reference>

pub fn unreference(&self, r: Reference)

pub fn entry_count(&self) -> usize

Count of the table entries

pub fn iter<'t>(&'t self) -> Result<TableIter<'l, &'t Self>>

Iterator to the table entries

pub fn into_iter(self) -> Result<TableIter<'l, Self>>

Like iter(), but take the ownership

pub fn raw_geti(&self, i: impl Into<lua_Integer>) -> Result<ValRef<'l>>

Get value by number index without metamethod triggers

pub fn raw_seti<V: ToLua>(&self, i: impl Into<lua_Integer>, v: V) -> Result<()>

Set value by number index without metamethod triggers

pub fn take_reference(&self, r: Reference) -> Result<ValRef<'l>>

pub fn raw_get<K: ToLua>(&self, key: K) -> Result<ValRef<'l>>

Get the value associated to key without metamethod triggers

pub fn raw_set<K: ToLua, V: ToLua>(&self, k: K, v: V) -> Result<()>

Set value by any key without metamethod triggers

pub fn raw_insert<V: ToLua>(&self, i: usize, val: V) -> Result<()>

Insert an element into the array table, equivalent to table.insert in lua

pub fn push<V: ToLua>(&self, val: V) -> Result<()>

Push an element to end of the array part of a table, alias to self.raw_seti((self.raw_len() + 1) as i64, val)

pub fn pairs(&self) -> Result<impl Iterator<Item = (Value<'_>, Value<'_>)>>

Iterator to the table entries

pub fn set_closure<'a, K: ToLua, A: 'a, R: 'a, F: LuaMethod<'a, (), A, R> + 'static>( &self, name: K, func: F, ) -> Result<&Self>

Alias to self.set(name, lua.new_closure(func))

pub fn set_function<'a, K: ToLua, ARGS: FromLuaMulti<'l>, RET: ToLuaMulti + 'l, F: Fn(&'l State, ARGS) -> RET + 'static>( &self, name: K, func: F, ) -> Result<&Self>

Alias to self.set(name, lua.new_function(func))

Methods from Deref<Target = ValRef<'l>>

pub fn deserialize<T: Deserialize<'a>>(&'a self) -> Result<T, DesErr>

Deserialize a lua value

pub fn transcode<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Transcode a lua value to another serialize format

pub fn state(&self) -> &'a State

pub fn type_of(&self) -> Type

Type of this value

pub fn is_nil(&self) -> bool

pub fn is_integer(&self) -> bool

pub fn is_table(&self) -> bool

pub fn is_function(&self) -> bool

pub fn check_safe_index(&self) -> Result<()>

pub fn to_safe_bytes(&self) -> Result<&'a [u8]>

pub fn to_safe_str(&self) -> Result<&'a str>

pub fn to_bytes(&self) -> Option<&[u8]>

pub fn to_str(&self) -> Option<&str>

pub fn to_string_lossy(&self) -> Option<Cow<'_, str>>

pub fn to_bool(&self) -> bool

pub fn to_integer(&self) -> lua_Integer

pub fn to_number(&self) -> lua_Number

pub fn to_pointer(&self) -> *const c_void

pub fn to_cstr_ptr(&self) -> *const c_char

pub fn tostring(&self) -> Cow<'_, str>

Call tostring if this value is not a string

pub fn index(&self) -> Index

Index number of this value on the lua stack

pub fn check_type(&self, ty: Type) -> Result<()>

pub fn check_type2(&self, ty1: Type, ty2: Type) -> Result<()>

pub fn cast<T: FromLua<'a> + 'static>(&self) -> Result<T>

Alias to cast_into(), not take the ownship, but only convert to static-lifetime types

pub fn geti(&self, i: impl Into<lua_Integer>) -> Result<ValRef<'a>>

Get value associated to integer key, equivalent to return self[i] in lua

pub fn seti<V: ToLua>(&self, i: impl Into<lua_Integer>, v: V) -> Result<()>

Set value with integer key, equivalent to self[i] = v in lua

pub fn len(&self) -> Result<ValRef<'a>>

Get length of the value, equivalent to return #self in lua

pub fn set<K: ToLua, V: ToLua>(&self, k: K, v: V) -> Result<()>

Set value with any key, equivalent to self[k] = v in lua

pub fn get<K: ToLua>(&self, key: K) -> Result<ValRef<'a>>

Get value associated to key, equivalent to return self[k] in lua

pub fn getopt<K: ToLua, V: FromLua<'a> + 'a>(&self, k: K) -> Result<Option<V>>

pub fn pcall<T: ToLuaMulti, R: FromLuaMulti<'a>>(&self, args: T) -> Result<R>

Call this value as a function

pub fn pcall_void<T: ToLuaMulti>(&self, args: T) -> Result<()>

Invoke pcall() without return value

pub fn has_metatable(&self) -> bool

pub fn metatable(&self) -> Result<Option<Table<'a>>>

Get metatable of lua table or userdata

pub fn set_metatable(&self, t: Table<'_>) -> Result<()>

Set metatable for lua table or userdata

pub fn remove_metatable(&self)

Remove metatable for lua table or userdata

pub fn call_metamethod<T: ToLuaMulti, R: FromLuaMulti<'a>>( &self, m: &str, args: T, ) -> Result<R>

Call a metamethod

pub fn call_close_and_remove_metatable(&self) -> Result<()>

pub fn raw_equal(&self, other: &Self) -> bool

Tests whether two lua values are equal without metamethod triggers

pub fn raw_len(&self) -> usize

Get length of the string/userdata/table without metamethod triggers

pub fn as_table(&self) -> Option<&Table<'a>>

pub fn as_function(&self) -> Option<&Function<'a>>

pub fn as_string(&self) -> Option<&LuaString<'a>>

pub fn as_thread(&self) -> Option<&LuaThread<'a>>

pub fn as_userdata(&self) -> Option<&LuaUserData<'a>>

pub fn airth_add(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_sub(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_mul(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_div(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_rem(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_bitand(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_bitor(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_bitxor(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_shl(&self, rhs: impl ToLua) -> Result<Self>

pub fn airth_shr(&self, rhs: impl ToLua) -> Result<Self>

pub fn arith_neg(&self) -> Result<Self>

pub fn arith_not(&self) -> Result<Self>

pub fn idiv(&self, rhs: impl ToLua) -> Result<Self>

pub fn pow(&self, rhs: impl ToLua) -> Result<Self>

Trait Implementations

impl<'a> AsRef<Table<'a>> for Table<'a>

fn as_ref(&self) -> &Table<'a>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'l> Clone for Table<'l>

fn clone(&self) -> Table<'l>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'l> Debug for Table<'l>

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

Formats the value using the given formatter.

impl<'l> Deref for Table<'l>

type Target = ValRef<'l>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> FromLua<'a> for Table<'a>

fn from_lua(_: &'a State, val: ValRef<'a>) -> Result<Self>

const TYPE_NAME: &'static str = _

impl<'a> Into<ValRef<'a>> for Table<'a>

fn into(self) -> ValRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> ToLua for Table<'a>

fn to_lua<'a>(self, lua: &'a State) -> Result<ValRef<'a>>

impl<'a> TryFrom<ValRef<'a>> for Table<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: ValRef<'a>) -> Result<Self>

Performs the conversion.