Skip to main content

Module lua

Module lua 

Source
Expand description

Embedded Lua bindings for byte-first path normalization.

This module is available with the lua feature. It does not define a cdylib Lua module; hosts embed it into their own mlua::Lua state and choose the namespace they want.

The lua feature deliberately does not select an mlua backend. The host process owns the Lua runtime decision and should enable exactly one shared backend in the final dependency graph. DreamWeave recommends LuaJIT in 5.2 compatibility mode and does not currently test these bindings against other Lua runtimes. Use this crate’s standalone-lua feature only for documentation builds, examples, and local smoke tests that do not already have a central Lua runtime crate.

Returned Lua strings may contain embedded NUL bytes; C hosts must use length-aware Lua APIs rather than C string length.

Constants§

MODULE_NAME
Default Lua global name used by register_module.

Functions§

create_module
Create the dream_path Lua API table without registering it globally.
register_module
Register the Lua API table as the dream_path global.
register_module_as
Register the Lua API table under a caller-selected global name.