Make state module public

Author: khvzak

src/lib.rs

@@ -79,7 +79,6 @@ mod error;
 mod memory;
 mod multi;
 mod scope;
-mod state;
 mod stdlib;
 mod traits;
 mod types;
@@ -93,6 +92,7 @@ pub mod function;
 #[cfg_attr(docsrs, doc(cfg(feature = "luau")))]
 pub mod luau;
 pub mod prelude;
+pub mod state;
 pub mod string;
 pub mod table;
 pub mod thread;
@@ -107,10 +107,8 @@ pub use crate::error::{Error, ErrorContext, ExternalError, ExternalResult, Resul
 pub use crate::function::Function;
 pub use crate::multi::{MultiValue, Variadic};
 pub use crate::scope::Scope;
-#[cfg(any(feature = "lua54", feature = "lua55"))]
-#[cfg_attr(docsrs, doc(cfg(any(feature = "lua54", feature = "lua55"))))]
-pub use crate::state::GcGenParams;
-pub use crate::state::{GcIncParams, GcMode, Lua, LuaOptions, WeakLua};
+#[doc(inline)]
+pub use crate::state::{Lua, LuaOptions, WeakLua};
 pub use crate::stdlib::StdLib;
 #[doc(inline)]
 pub use crate::string::{BorrowedBytes, BorrowedStr, LuaString};

src/prelude.rs

@@ -5,17 +5,17 @@ pub use crate::{
     AnyUserData as LuaAnyUserData, BorrowedBytes as LuaBorrowedBytes, BorrowedStr as LuaBorrowedStr,
     Chunk as LuaChunk, ChunkMode as LuaChunkMode, Either as LuaEither, Error as LuaError,
     ErrorContext as LuaErrorContext, ExternalError as LuaExternalError, ExternalResult as LuaExternalResult,
-    FromLua, FromLuaMulti, Function as LuaFunction, GcIncParams as LuaGcIncParams, GcMode as LuaGcMode,
-    Integer as LuaInteger, IntoLua, IntoLuaMulti, LightUserData as LuaLightUserData, Lua, LuaNativeFn,
-    LuaNativeFnMut, LuaOptions, LuaString, MetaMethod as LuaMetaMethod, MultiValue as LuaMultiValue,
-    Nil as LuaNil, Number as LuaNumber, ObjectLike as LuaObjectLike, RegistryKey as LuaRegistryKey,
-    Result as LuaResult, StdLib as LuaStdLib, Table as LuaTable, Thread as LuaThread,
-    UserData as LuaUserData, UserDataFields as LuaUserDataFields, UserDataMetatable as LuaUserDataMetatable,
-    UserDataMethods as LuaUserDataMethods, UserDataRef as LuaUserDataRef,
-    UserDataRefMut as LuaUserDataRefMut, UserDataRegistry as LuaUserDataRegistry, Value as LuaValue,
-    Variadic as LuaVariadic, VmState as LuaVmState, WeakLua, function::FunctionInfo as LuaFunctionInfo,
-    table::TablePairs as LuaTablePairs, table::TableSequence as LuaTableSequence,
-    thread::ThreadStatus as LuaThreadStatus,
+    FromLua, FromLuaMulti, Function as LuaFunction, Integer as LuaInteger, IntoLua, IntoLuaMulti,
+    LightUserData as LuaLightUserData, Lua, LuaNativeFn, LuaNativeFnMut, LuaOptions, LuaString,
+    MetaMethod as LuaMetaMethod, MultiValue as LuaMultiValue, Nil as LuaNil, Number as LuaNumber,
+    ObjectLike as LuaObjectLike, RegistryKey as LuaRegistryKey, Result as LuaResult, StdLib as LuaStdLib,
+    Table as LuaTable, Thread as LuaThread, UserData as LuaUserData, UserDataFields as LuaUserDataFields,
+    UserDataMetatable as LuaUserDataMetatable, UserDataMethods as LuaUserDataMethods,
+    UserDataRef as LuaUserDataRef, UserDataRefMut as LuaUserDataRefMut,
+    UserDataRegistry as LuaUserDataRegistry, Value as LuaValue, Variadic as LuaVariadic,
+    VmState as LuaVmState, WeakLua, function::FunctionInfo as LuaFunctionInfo,
+    state::GcIncParams as LuaGcIncParams, state::GcMode as LuaGcMode, table::TablePairs as LuaTablePairs,
+    table::TableSequence as LuaTableSequence, thread::ThreadStatus as LuaThreadStatus,
 };
 
 #[cfg(not(feature = "luau"))]
@@ -24,7 +24,7 @@ pub use crate::HookTriggers as LuaHookTriggers;
 
 #[cfg(any(feature = "lua54", feature = "lua55"))]
 #[doc(no_inline)]
-pub use crate::GcGenParams as LuaGcGenParams;
+pub use crate::state::GcGenParams as LuaGcGenParams;
 
 #[cfg(feature = "luau")]
 #[doc(no_inline)]

src/state.rs

@@ -1,3 +1,8 @@
+//! Lua state management.
+//!
+//! This module provides the main [`Lua`] state handle together with state-specific
+//! configuration and garbage collector controls.
+
 use std::any::TypeId;
 use std::cell::{BorrowError, BorrowMutError, RefCell};
 use std::marker::PhantomData;
@@ -44,6 +49,7 @@ use {
 use serde::Serialize;
 
 pub(crate) use extra::ExtraData;
+#[doc(hidden)]
 pub use raw::RawLua;
 pub(crate) use util::callback_error_ext;
 

tests/memory.rs

@@ -1,8 +1,10 @@
 use std::sync::Arc;
 
+use mlua::state::{GcIncParams, GcMode};
+use mlua::{Error, Lua, Result, UserData};
+
 #[cfg(any(feature = "lua54", feature = "lua55"))]
-use mlua::GcGenParams;
-use mlua::{Error, GcIncParams, GcMode, Lua, Result, UserData};
+use mlua::state::GcGenParams;
 
 #[test]
 fn test_memory_limit() -> Result<()> {