Struct mlua::Variadic

pub struct Variadic<T>(_);

Wraps a variable number of Ts.

Can be used to work with variadic functions more easily. Using this type as the last argument of a Rust callback will accept any number of arguments from Lua and convert them to the type T using FromLua. Variadic<T> can also be returned from a callback, returning a variable number of values to Lua.

The MultiValue type is equivalent to Variadic<Value>.

Examples

let add = lua.create_function(|_, vals: Variadic<f64>| -> Result<f64> {
    Ok(vals.iter().sum())
})?;
lua.globals().set("add", add)?;
assert_eq!(lua.load("add(3, 2, 5)").eval::<f32>()?, 10.0);

Methods

impl<T> Variadic<T>

pub fn new() -> Variadic<T>

Creates an empty Variadic wrapper containing no values.

Trait Implementations

impl<T: Clone> Clone for Variadic<T>

fn clone(&self) -> Variadic<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Variadic<T>

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

Formats the value using the given formatter.

impl<T> Default for Variadic<T>

fn default() -> Variadic<T>

Returns the "default value" for a type.

impl<T> Deref for Variadic<T>

type Target = Vec<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Variadic<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> FromIterator<T> for Variadic<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<'lua, T: FromLua<'lua>> FromLuaMulti<'lua> for Variadic<T>

fn from_lua_multi(values: MultiValue<'lua>, lua: &'lua Lua) -> Result<Self>

Performs the conversion.

impl<T> IntoIterator for Variadic<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = <Vec<T> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'lua, T: ToLua<'lua>> ToLuaMulti<'lua> for Variadic<T>

fn to_lua_multi(self, lua: &'lua Lua) -> Result<MultiValue<'lua>>

Performs the conversion.