Make luau module public

Author: khvzak

src/function.rs

@@ -246,7 +246,7 @@ impl Function {
     /// # }
     /// ```
     ///
-    /// [`AsyncThread`]: crate::AsyncThread
+    /// [`AsyncThread`]: crate::thread::AsyncThread
     #[cfg(feature = "async")]
     #[cfg_attr(docsrs, doc(cfg(feature = "async")))]
     pub fn call_async<R>(&self, args: impl IntoLuaMulti) -> AsyncCallFuture<R>

src/lib.rs

@@ -76,8 +76,6 @@ mod buffer;
 mod chunk;
 mod conversion;
 mod error;
-#[cfg(any(feature = "luau", doc))]
-mod luau;
 mod memory;
 mod multi;
 mod scope;
@@ -91,6 +89,9 @@ mod vector;
 
 pub mod debug;
 pub mod function;
+#[cfg(any(feature = "luau", doc))]
+#[cfg_attr(docsrs, doc(cfg(feature = "luau")))]
+pub mod luau;
 pub mod prelude;
 pub mod string;
 pub mod table;
@@ -147,7 +148,6 @@ pub use crate::debug::HookTriggers;
 pub use crate::{
     buffer::Buffer,
     chunk::{CompileConstant, Compiler},
-    luau::{FsRequirer, HeapDump, NavigateError, Require},
     vector::Vector,
 };
 

src/luau/mod.rs

@@ -1,3 +1,19 @@
+//! Luau-specific extensions and types.
+//!
+//! This module provides Luau-specific functionality including custom `require` implementations,
+//! heap memory analysis, and Luau VM integration utilities.
+//!
+//! # Overview
+//!
+//! - [`Require`] — trait for implementing custom module loaders used with
+//!   [`Lua::create_require_function`]
+//! - [`FsRequirer`] — default filesystem-based [`Require`] implementation
+//! - [`NavigateError`] — error type returned when navigating the module path
+//! - [`HeapDump`] — snapshot of Luau heap memory usage, obtained via [`Lua::heap_dump`]
+//!
+//! [`Lua::create_require_function`]: crate::Lua::create_require_function
+//! [`Lua::heap_dump`]: crate::Lua::heap_dump
+
 use std::ffi::{CStr, CString};
 use std::os::raw::c_int;
 use std::ptr;

src/prelude.rs

@@ -25,8 +25,11 @@ pub use crate::HookTriggers as LuaHookTriggers;
 #[cfg(feature = "luau")]
 #[doc(no_inline)]
 pub use crate::{
-    CompileConstant as LuaCompileConstant, Compiler as LuaCompiler, FsRequirer as LuaFsRequirer,
-    NavigateError as LuaNavigateError, Require as LuaRequire, Vector as LuaVector,
+    CompileConstant as LuaCompileConstant, Compiler as LuaCompiler, Vector as LuaVector,
+    luau::{
+        FsRequirer as LuaFsRequirer, HeapDump as LuaHeapDump, NavigateError as LuaNavigateError,
+        Require as LuaRequire,
+    },
 };
 
 #[cfg(feature = "async")]

src/state.rs

@@ -1456,7 +1456,7 @@ impl Lua {
     /// }
     /// ```
     ///
-    /// [`AsyncThread`]: crate::AsyncThread
+    /// [`AsyncThread`]: crate::thread::AsyncThread
     #[cfg(feature = "async")]
     #[cfg_attr(docsrs, doc(cfg(feature = "async")))]
     pub fn create_async_function<F, A, FR, R>(&self, func: F) -> Result<Function>

tests/luau/require.rs

@@ -1,7 +1,8 @@
 use std::io::Result as IoResult;
 use std::result::Result as StdResult;
 
-use mlua::{Error, FromLua, FsRequirer, IntoLua, Lua, MultiValue, NavigateError, Require, Result, Value};
+use mlua::luau::{FsRequirer, NavigateError, Require};
+use mlua::{Error, FromLua, IntoLua, Lua, MultiValue, Result, Value};
 
 fn run_require(lua: &Lua, path: impl IntoLua) -> Result<Value> {
     lua.load(r#"return require(...)"#).call(path)