Merge pull request #200 from yjhmelody/derive-debug

derive debug for some rlua types

Author: jugglerchris

src/context.rs

@@ -24,7 +24,7 @@ use crate::util::{
 };
 use crate::value::{FromLua, FromLuaMulti, MultiValue, Nil, ToLua, ToLuaMulti, Value};
 
-#[derive(Copy, Clone)]
+#[derive(Copy, Clone, Debug)]
 pub struct Context<'lua> {
     pub(crate) state: *mut ffi::lua_State,
     _lua_invariant: Invariant<'lua>,

src/ffi.rs

@@ -3,27 +3,35 @@
 #![allow(unused)]
 
 use std::mem;
-use std::os::raw::{c_char, c_double, c_int, c_longlong, c_uchar, c_uint, c_ulonglong, c_ushort, c_void};
+use std::os::raw::{
+    c_char, c_double, c_int, c_longlong, c_uchar, c_uint, c_ulonglong, c_ushort, c_void,
+};
 use std::ptr;
 
 pub type lua_Integer = c_longlong;
 pub type lua_Unsigned = c_ulonglong;
 pub type lua_Number = c_double;
 
 pub enum lua_State {}
+
 pub type lua_Alloc = unsafe extern "C" fn(
     ud: *mut c_void,
     ptr: *mut c_void,
     osize: usize,
     nsize: usize,
 ) -> *mut c_void;
+
 pub type lua_KContext = *mut c_void;
+
 pub type lua_KFunction =
     unsafe extern "C" fn(state: *mut lua_State, status: c_int, ctx: lua_KContext) -> c_int;
+
 pub type lua_CFunction = unsafe extern "C" fn(state: *mut lua_State) -> c_int;
+
 pub type lua_Hook = unsafe extern "C" fn(state: *mut lua_State, ar: *mut lua_Debug);
 
 #[repr(C)]
+#[derive(Debug)]
 pub struct lua_Debug {
     pub event: c_int,
     pub name: *const c_char,
@@ -81,9 +89,9 @@ pub const LUA_GCCOLLECT: c_int = 2;
 pub const LUA_GCCOUNT: c_int = 3;
 pub const LUA_GCCOUNTB: c_int = 4;
 pub const LUA_GCSTEP: c_int = 5;
-#[deprecated(note="please use `LUA_GCINC` instead")]
+#[deprecated(note = "please use `LUA_GCINC` instead")]
 pub const LUA_GCSETPAUSE: c_int = 6;
-#[deprecated(note="please use `LUA_GCINC` instead")]
+#[deprecated(note = "please use `LUA_GCINC` instead")]
 pub const LUA_GCSETSTEPMUL: c_int = 7;
 pub const LUA_GCISRUNNING: c_int = 9;
 pub const LUA_GCGEN: c_int = 10;
@@ -113,7 +121,12 @@ extern "C" {
         ctx: lua_KContext,
         k: Option<lua_KFunction>,
     ) -> c_int;
-    pub fn lua_resume(state: *mut lua_State, from: *mut lua_State, nargs: c_int, nresults: *mut c_int) -> c_int;
+    pub fn lua_resume(
+        state: *mut lua_State,
+        from: *mut lua_State,
+        nargs: c_int,
+        nresults: *mut c_int,
+    ) -> c_int;
     pub fn lua_status(state: *mut lua_State) -> c_int;
 
     pub fn lua_pushnil(state: *mut lua_State);

src/hook.rs

@@ -16,7 +16,7 @@ use crate::util::callback_error;
 ///
 /// [lua_doc]: https://www.lua.org/manual/5.4/manual.html#lua_Debug
 /// [`Lua::set_hook`]: struct.Lua.html#method.set_hook
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct Debug<'a> {
     ar: *mut lua_Debug,
     state: *mut lua_State,

src/lua.rs

@@ -66,6 +66,7 @@ bitflags! {
 const SAFE_CSTACK_SIZE: c_uint = 700;
 
 /// Top level Lua struct which holds the Lua state itself.
+#[derive(Debug)]
 pub struct Lua {
     main_state: *mut ffi::lua_State,
     _no_ref_unwind_safe: NoRefUnwindSafe,
@@ -357,7 +358,15 @@ impl Lua {
     ///
     /// [lua_doc]: https://www.lua.org/manual/5.4/manual.html#2.5
     pub fn gc_set_inc(&self, pause: c_int, step_multiplier: c_int, step_size: c_int) -> c_int {
-        unsafe { ffi::lua_gc(self.main_state, ffi::LUA_GCINC, pause, step_multiplier, step_size) }
+        unsafe {
+            ffi::lua_gc(
+                self.main_state,
+                ffi::LUA_GCINC,
+                pause,
+                step_multiplier,
+                step_size,
+            )
+        }
     }
 
     /// Sets the garbage collector to generational mode.
@@ -367,7 +376,14 @@ impl Lua {
     ///
     /// [lua_doc]: https://www.lua.org/manual/5.4/manual.html#2.5
     pub fn gc_set_gen(&self, minor_multiplier: c_int, major_multiplier: c_int) -> c_int {
-        unsafe { ffi::lua_gc(self.main_state, ffi::LUA_GCGEN, minor_multiplier, major_multiplier) }
+        unsafe {
+            ffi::lua_gc(
+                self.main_state,
+                ffi::LUA_GCGEN,
+                minor_multiplier,
+                major_multiplier,
+            )
+        }
     }
 
     /// Sets the 'pause' value of the incremental collector.
@@ -376,7 +392,7 @@ impl Lua {
     /// documentation][lua_doc].
     ///
     /// [lua_doc]: https://www.lua.org/manual/5.4/manual.html#2.5
-    #[deprecated(note="please use `gc_set_inc` instead")]
+    #[deprecated(note = "please use `gc_set_inc` instead")]
     #[allow(deprecated)]
     pub fn gc_set_pause(&self, pause: c_int) -> c_int {
         unsafe { ffi::lua_gc(self.main_state, ffi::LUA_GCSETPAUSE, pause) }
@@ -388,7 +404,7 @@ impl Lua {
     /// [Lua 5.4 documentation][lua_doc].
     ///
     /// [lua_doc]: https://www.lua.org/manual/5.4/manual.html#2.5
-    #[deprecated(note="please use `gc_set_inc` instead")]
+    #[deprecated(note = "please use `gc_set_inc` instead")]
     #[allow(deprecated)]
     pub fn gc_set_step_multiplier(&self, step_multiplier: c_int) -> c_int {
         unsafe { ffi::lua_gc(self.main_state, ffi::LUA_GCSETSTEPMUL, step_multiplier) }

src/scope.rs

@@ -24,6 +24,7 @@ use crate::value::{FromLuaMulti, MultiValue, ToLuaMulti, Value};
 /// See [`Context::scope`] for more details.
 ///
 /// [`Context::scope`]: struct.Context.html#method.scope
+#[derive(Debug)]
 pub struct Scope<'lua, 'scope> {
     lua: Context<'lua>,
     destructors: RefCell<Vec<(LuaRef<'lua>, fn(LuaRef<'lua>) -> Box<dyn Any>)>>,

src/userdata.rs

@@ -1,5 +1,5 @@
 use std::cell::{Ref, RefCell, RefMut};
-use std::os::raw::{c_int};
+use std::os::raw::c_int;
 
 use crate::context::Context;
 use crate::error::{Error, Result};
@@ -282,7 +282,9 @@ pub trait UserData: Sized {
 
     /// Used to determine how many user values this userdata should have.
     /// Defaults to a single user value.
-    fn get_uvalues_count(&self) -> c_int {1}
+    fn get_uvalues_count(&self) -> c_int {
+        1
+    }
 }
 
 /// Handle to an internal Lua userdata for any type that implements [`UserData`].
@@ -352,7 +354,10 @@ impl<'lua> AnyUserData<'lua> {
             lua.push_ref(&self.0);
             lua.push_value(v)?;
             if ffi::lua_setiuservalue(lua.state, -2, n) == 0 {
-                Err(Error::RuntimeError(format!("userdata does not have user value {}", n)))
+                Err(Error::RuntimeError(format!(
+                    "userdata does not have user value {}",
+                    n
+                )))
             } else {
                 Ok(())
             }
@@ -370,7 +375,10 @@ impl<'lua> AnyUserData<'lua> {
             lua.push_ref(&self.0);
             if ffi::lua_getiuservalue(lua.state, -1, n) == ffi::LUA_TNIL {
                 lua.pop_value(); // remove the nil from the stack
-                return Err(Error::RuntimeError(format!("userdata does not have user value {}", n)))
+                return Err(Error::RuntimeError(format!(
+                    "userdata does not have user value {}",
+                    n
+                )));
             }
             lua.pop_value()
         };

src/util.rs

@@ -221,8 +221,15 @@ pub unsafe fn push_string<S: ?Sized + AsRef<[u8]>>(
 }
 
 // Internally uses 4 stack spaces, does not call checkstack
-pub unsafe fn push_userdata_uv<T>(state: *mut ffi::lua_State, t: T, uvalues_count: c_int) -> Result<()> {
-    rlua_debug_assert!(uvalues_count > 0, "userdata user values cannot be below zero");
+pub unsafe fn push_userdata_uv<T>(
+    state: *mut ffi::lua_State,
+    t: T,
+    uvalues_count: c_int,
+) -> Result<()> {
+    rlua_debug_assert!(
+        uvalues_count > 0,
+        "userdata user values cannot be below zero"
+    );
     let ud = protect_lua_closure(state, 0, 1, move |state| {
         ffi::lua_newuserdatauv(state, mem::size_of::<T>(), uvalues_count) as *mut T
     })?;
@@ -412,7 +419,8 @@ pub unsafe extern "C" fn error_traceback(state: *mut ffi::lua_State) -> c_int {
         // lua_newuserdatauv and luaL_traceback may error, but nothing that implements Drop should be
         // on the rust stack at this time.
         // We don't need any user values in this userdata
-        let ud = ffi::lua_newuserdatauv(state, mem::size_of::<WrappedError>(), 0) as *mut WrappedError;
+        let ud =
+            ffi::lua_newuserdatauv(state, mem::size_of::<WrappedError>(), 0) as *mut WrappedError;
         let traceback = if ffi::lua_checkstack(state, LUA_TRACEBACK_STACK) != 0 {
             ffi::luaL_traceback(state, state, ptr::null(), 0);
 
@@ -629,7 +637,8 @@ pub unsafe fn init_error_registry(state: *mut ffi::lua_State) {
     unsafe extern "C" fn destructed_error(state: *mut ffi::lua_State) -> c_int {
         ffi::luaL_checkstack(state, 2, ptr::null());
         // We don't need any user values in this userdata
-        let ud = ffi::lua_newuserdatauv(state, mem::size_of::<WrappedError>(), 0) as *mut WrappedError;
+        let ud =
+            ffi::lua_newuserdatauv(state, mem::size_of::<WrappedError>(), 0) as *mut WrappedError;
 
         ptr::write(ud, WrappedError(Error::CallbackDestructed));
         get_error_metatable(state);

tests/userdata.rs

@@ -1,5 +1,5 @@
+use std::os::raw::c_int;
 use std::sync::Arc;
-use std::os::raw::{c_int};
 
 use rlua::{
     AnyUserData, ExternalError, Function, Lua, MetaMethod, String, UserData, UserDataMethods,
@@ -183,7 +183,9 @@ fn detroys_userdata() {
 fn user_value() {
     struct MyUserData;
     impl UserData for MyUserData {
-        fn get_uvalues_count(&self) -> c_int {2}
+        fn get_uvalues_count(&self) -> c_int {
+            2
+        }
     }
 
     Lua::new().context(|lua| {