Struct lune_utils::TableBuilder

pub struct TableBuilder<'lua> { /* private fields */ }

Utility struct for building Lua tables.

Implementations

impl<'lua> TableBuilder<'lua>

pub fn new(lua: &'lua Lua) -> LuaResult<Self>

Creates a new table builder.

pub fn with_value<K, V>(self, key: K, value: V) -> LuaResult<Self>

where K: IntoLua<'lua>, V: IntoLua<'lua>,

Adds a new key-value pair to the table.

This will overwrite any value that already exists.

pub fn with_values<K, V>(self, values: Vec<(K, V)>) -> LuaResult<Self>

where K: IntoLua<'lua>, V: IntoLua<'lua>,

Adds multiple key-value pairs to the table.

This will overwrite any values that already exist.

pub fn with_sequential_value<V>(self, value: V) -> LuaResult<Self>

where V: IntoLua<'lua>,

Adds a new key-value pair to the sequential (array) section of the table.

This will not overwrite any value that already exists, instead adding the value to the end of the array.

pub fn with_sequential_values<V>(self, values: Vec<V>) -> LuaResult<Self>

where V: IntoLua<'lua>,

Adds multiple values to the sequential (array) section of the table.

This will not overwrite any values that already exist, instead adding the values to the end of the array.

pub fn with_function<K, A, R, F>(self, key: K, func: F) -> LuaResult<Self>

where K: IntoLua<'lua>, A: FromLuaMulti<'lua>, R: IntoLuaMulti<'lua>, F: Fn(&'lua Lua, A) -> LuaResult<R> + 'static,

Adds a new key-value pair to the table, with a function value.

This will overwrite any value that already exists.

pub fn with_async_function<K, A, R, F, FR>( self, key: K, func: F ) -> LuaResult<Self>

where K: IntoLua<'lua>, A: FromLuaMulti<'lua>, R: IntoLuaMulti<'lua>, F: Fn(&'lua Lua, A) -> FR + 'static, FR: Future<Output = LuaResult<R>> + 'lua,

Adds a new key-value pair to the table, with an async function value.

This will overwrite any value that already exists.

pub fn with_metatable(self, table: LuaTable<'_>) -> LuaResult<Self>

Adds a metatable to the table.

This will overwrite any metatable that already exists.

pub fn build_readonly(self) -> LuaResult<LuaTable<'lua>>

Builds the table as a read-only table.

This will prevent any direct modifications to the table.

pub fn build(self) -> LuaResult<LuaTable<'lua>>

Builds the table.