Make string module public

Author: khvzak

src/lib.rs

@@ -82,7 +82,6 @@ mod multi;
 mod scope;
 mod state;
 mod stdlib;
-mod string;
 mod thread;
 mod traits;
 mod types;
@@ -94,6 +93,7 @@ mod vector;
 pub mod debug;
 pub mod function;
 pub mod prelude;
+pub mod string;
 pub mod table;
 
 pub use bstr::BString;
@@ -106,7 +106,7 @@ pub use crate::multi::{MultiValue, Variadic};
 pub use crate::scope::Scope;
 pub use crate::state::{GCMode, Lua, LuaOptions, WeakLua};
 pub use crate::stdlib::StdLib;
-pub use crate::string::{BorrowedBytes, BorrowedStr, LuaString, LuaString as String};
+pub use crate::string::{BorrowedBytes, BorrowedStr, LuaString};
 pub use crate::table::Table;
 pub use crate::thread::{Thread, ThreadStatus};
 pub use crate::traits::{
@@ -122,6 +122,9 @@ pub use crate::userdata::{
 };
 pub use crate::value::{Nil, Value};
 
+#[doc(hidden)]
+pub use crate::string::LuaString as String;
+
 #[cfg(not(feature = "luau"))]
 pub use crate::debug::HookTriggers;
 

src/string.rs

@@ -1,3 +1,13 @@
+//! Lua string handling.
+//!
+//! This module provides types for working with Lua strings from Rust.
+//!
+//! # Main Types
+//!
+//! - [`LuaString`] - A handle to an internal Lua string (may not be valid UTF-8).
+//! - [`BorrowedStr`] - A borrowed `&str` view of a Lua string that holds a strong reference to the Lua state.
+//! - [`BorrowedBytes`] - A borrowed `&[u8]` view of a Lua string that holds a strong reference to the Lua state.
+
 use std::borrow::{Borrow, Cow};
 use std::hash::{Hash, Hasher};
 use std::ops::Deref;