Make error module public

Author: khvzak

src/error.rs

@@ -1,3 +1,8 @@
+//! Lua error handling.
+//!
+//! This module provides the [`Error`] type returned by all fallible `mlua` operations, together
+//! with extension traits for adapting Rust errors for use within Lua.
+
 use std::error::Error as StdError;
 use std::fmt;
 use std::io::Error as IoError;

src/lib.rs

@@ -75,7 +75,6 @@ mod macros;
 mod buffer;
 mod chunk;
 mod conversion;
-mod error;
 mod memory;
 mod multi;
 mod scope;
@@ -87,6 +86,7 @@ mod value;
 mod vector;
 
 pub mod debug;
+pub mod error;
 pub mod function;
 #[cfg(any(feature = "luau", doc))]
 #[cfg_attr(docsrs, doc(cfg(feature = "luau")))]
@@ -102,7 +102,8 @@ pub use bstr::BString;
 pub use ffi::{self, lua_CFunction, lua_State};
 
 pub use crate::chunk::{AsChunk, Chunk, ChunkMode};
-pub use crate::error::{Error, ErrorContext, ExternalError, ExternalResult, Result};
+#[doc(inline)]
+pub use crate::error::{Error, Result};
 #[doc(inline)]
 pub use crate::function::Function;
 pub use crate::multi::{MultiValue, Variadic};
@@ -129,6 +130,8 @@ pub use crate::value::{Nil, Value};
 
 // Re-export some types to keep backward compatibility and avoid breaking changes in the public API.
 #[doc(hidden)]
+pub use crate::error::{ErrorContext, ExternalError, ExternalResult};
+#[doc(hidden)]
 pub use crate::string::LuaString as String;
 #[doc(hidden)]
 pub use crate::table::{TablePairs, TableSequence};

src/prelude.rs

@@ -3,19 +3,20 @@
 #[doc(no_inline)]
 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, Integer as LuaInteger, IntoLua, IntoLuaMulti,
+    Chunk as LuaChunk, ChunkMode as LuaChunkMode, Either as LuaEither, Error as LuaError, 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,
+    VmState as LuaVmState, WeakLua, error::ErrorContext as LuaErrorContext,
+    error::ExternalError as LuaExternalError, error::ExternalResult as LuaExternalResult,
+    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"))]