pub struct Table<'lua>(_);
Expand description
Handle to an internal Lua table.
Implementations
sourceimpl<'lua> Table<'lua>
impl<'lua> Table<'lua>
sourcepub fn set<K: ToLua<'lua>, V: ToLua<'lua>>(
&self,
key: K,
value: V
) -> Result<()>
pub fn set<K: ToLua<'lua>, V: ToLua<'lua>>(
&self,
key: K,
value: V
) -> Result<()>
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_context.globals();
globals.set("assertions", cfg!(debug_assertions))?;
lua_context.load(r#"
if assertions == true then
-- ...
elseif assertions == false then
-- ...
else
error("assertions neither on nor off?")
end
"#).exec()?;
sourcepub fn get<K: ToLua<'lua>, V: FromLua<'lua>>(&self, key: K) -> Result<V>
pub fn get<K: ToLua<'lua>, V: FromLua<'lua>>(&self, key: K) -> Result<V>
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_context.globals();
let version: String = globals.get("_VERSION")?;
println!("Lua version: {}", version);
sourcepub fn contains_key<K: ToLua<'lua>>(&self, key: K) -> Result<bool>
pub fn contains_key<K: ToLua<'lua>>(&self, key: K) -> Result<bool>
Checks whether the table contains a non-nil value for key
.
sourcepub fn raw_set<K: ToLua<'lua>, V: ToLua<'lua>>(
&self,
key: K,
value: V
) -> Result<()>
pub fn raw_set<K: ToLua<'lua>, V: ToLua<'lua>>(
&self,
key: K,
value: V
) -> Result<()>
Sets a key-value pair without invoking metamethods.
sourcepub fn raw_get<K: ToLua<'lua>, V: FromLua<'lua>>(&self, key: K) -> Result<V>
pub fn raw_get<K: ToLua<'lua>, V: FromLua<'lua>>(&self, key: K) -> Result<V>
Gets the value associated to key
without invoking metamethods.
sourcepub fn len(&self) -> Result<Integer>
pub fn len(&self) -> Result<Integer>
Returns the result of the Lua #
operator.
This might invoke the __len
metamethod. Use the raw_len
method if that is not desired.
sourcepub fn raw_len(&self) -> Integer
pub fn raw_len(&self) -> Integer
Returns the result of the Lua #
operator, without invoking the __len
metamethod.
sourcepub fn get_metatable(&self) -> Option<Table<'lua>>
pub fn get_metatable(&self) -> Option<Table<'lua>>
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.
sourcepub fn set_metatable(&self, metatable: Option<Table<'lua>>)
pub fn set_metatable(&self, metatable: Option<Table<'lua>>)
Sets or removes the metatable of this table.
If metatable
is None
, the metatable is removed (if no metatable is set, this does
nothing).
sourcepub 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)>;
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)>;
K: FromLua<'lua>,
V: FromLua<'lua>, type Item = Result<(K, V)>;
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_context.globals();
for pair in globals.pairs::<Value, Value>() {
let (key, value) = pair?;
// ...
}
sourcepub 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>;
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>;
V: FromLua<'lua>, type Item = Result<V>;
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 behaviour 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_context.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?);
}
Trait Implementations
Auto Trait Implementations
impl<'lua> !RefUnwindSafe for Table<'lua>
impl<'lua> !Send for Table<'lua>
impl<'lua> !Sync for Table<'lua>
impl<'lua> Unpin for Table<'lua>
impl<'lua> !UnwindSafe for Table<'lua>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more