Struct Function 

pub struct Function { /* private fields */ }

A handle to a callable Lua value (a Lua closure or a Rust function).

Mirrors mlua::Function. Under the send feature it is Send but never Sync — see [crate::sync::NotSync].

Implementations

impl Function

pub fn lua(&self) -> Lua

The owning Lua.

pub fn call<R: FromLuaMulti>(&self, args: impl IntoLuaMulti) -> Result<R>

Call the function with args, converting the results to R.

Mirrors mlua::Function::call. Runs under lua_pcall, so a Lua runtime error (or a Rust callback returning Err) becomes Err(Error) rather than unwinding.

pub fn bind(&self, args: impl IntoLuaMulti) -> Result<Function>

Return a new function that, when called, prepends args to its own arguments and forwards to self.

Mirrors mlua::Function::bind. Implemented as a Rust closure that captures the bound prefix and the target function.

pub fn wrap<F, A, R, E>(func: F) -> impl IntoLua

where F: LuaNativeFn<A, Output = Result<R, E>> + MaybeSend + 'static, A: FromLuaMulti, R: IntoLuaMulti, E: ExternalError,

Wrap a plain Rust closure as a value convertible into a Lua function.

Mirrors mlua::Function::wrap. Unlike Lua::create_function, the closure does not receive the Lua and its arity is free (||, |a|, |a, b|, … mapped from the Lua call arguments). The returned value is IntoLua so it can be stored directly (e.g. table.set("f", Function::wrap(|a, b| Ok::<_, Error>(a + b)))). A returned Err is raised as a Lua error.

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

A raw pointer identifying this function (for identity comparison). Mirrors mlua::Function::to_pointer.

pub fn environment(&self) -> Option<Table>

The function’s environment table (its globals), or None for a Rust (C) function. Mirrors mlua::Function::environment.

pub fn set_environment(&self, env: Table) -> Result<bool>

Set the function’s environment table. Returns Ok(false) for a Rust (C) function (which has no settable environment) and Ok(true) for a Lua closure. Mirrors mlua::Function::set_environment.

pub fn info(&self) -> FunctionInfo

Debug information about this function. Mirrors mlua::Function::info.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl FromLua for Function

fn from_lua(value: Value, _lua: &Lua) -> Result<Self>

Perform the conversion.

fn from_lua_arg( arg: Value, _i: usize, _to: Option<&str>, lua: &Lua, ) -> Result<Self>

Convert an argument at 1-based position i. The default forwards to FromLua::from_lua; specific impls can produce nicer messages. Mirrors mlua::FromLua::from_lua_arg.

impl IntoLua for Function

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl IntoLua for &Function

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl PartialEq for Function

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMetatable for Function

fn set_type_metatable(lua: &Lua, metatable: Option<Table>)

Install (or clear) the shared metatable for this type.

fn type_metatable(lua: &Lua) -> Option<Table>

The shared metatable for this type, if installed.