[Question] Mass-registration of functions / equivalent of luaL_register? about mlua HOT 7 CLOSED

Thanks for the feedback!
I agree that documentation need to be updated. In future I'll publish a detailed manual to cover usage / options / examples.

from mlua.

Your intuition is completely right :)
As in the example, you could just return a table of functions, that Lua will cache into package.loaded[modname] when loading your module using require

fn func1(_: &Lua, _: ()) -> LuaResult<()> {
    Ok(())
}

fn func2(_: &Lua, _: ()) -> LuaResult<()> {
    Ok(())
}

#[mlua::lua_module]
fn rust_module(lua: &Lua) -> LuaResult<LuaTable> {
    lua.create_table_from(vec![
        ("func1", lua.create_function(func1)?),
        ("func2", lua.create_function(func2)?),
    ])
}

Inside init function in your module you also have access to globals and can additionally register your data.

from mlua.

Thanks for the sample code— I will be doing this pattern a lot so maybe I will see if I can simply it with a macro, and if I do this maybe I will check back about whether you would like it upstream as a PR.

from mlua.

Thanks. As a piece of feedback, I am looking at the mlua docs and I don't see any docs for lua_module, nor do I see docs for the "module" or "mlua_derive" features. Is there a doc somewhere I am missing? Could docs for the correct usage of lua_module be added?

from mlua.

Oh, sorry, I see there are some docs in the README. Though it still doesn't seem to explain exactly what #lua_module does.

from mlua.

Okay, I think I've figured out that "standalone mode" is building a normal exe with mlua and "module mode" is building a shared object to be loaded by Lua.

I think the README would be clearer if you added a sentence under "Module mode" such as

"Use this mode to create a compiled Lua module that can be loaded from Lua code using require."

from mlua.

I updated README

from mlua.