Deprecate Debug::curr_line() in favour of Debug::current_line() that returns Option

Author: khvzak

src/debug.rs

@@ -133,8 +133,14 @@ impl<'a> Debug<'a> {
         }
     }
 
-    /// Corresponds to the `l` "what" mask. Returns the current line.
+    #[doc(hidden)]
+    #[deprecated(note = "Use `current_line` instead")]
     pub fn curr_line(&self) -> i32 {
+        self.current_line().map(|n| n as i32).unwrap_or(-1)
+    }
+
+    /// Corresponds to the `l` "what" mask. Returns the current line.
+    pub fn current_line(&self) -> Option<usize> {
         unsafe {
             #[cfg(not(feature = "luau"))]
             mlua_assert!(
@@ -147,7 +153,7 @@ impl<'a> Debug<'a> {
                 "lua_getinfo failed with `l`"
             );
 
-            (*self.ar).currentline
+            linenumber_to_usize((*self.ar).currentline)
         }
     }
 

src/state.rs

@@ -577,7 +577,7 @@ impl Lua {
     /// # fn main() -> Result<()> {
     /// let lua = Lua::new();
     /// lua.set_hook(HookTriggers::EVERY_LINE, |_lua, debug| {
-    ///     println!("line {}", debug.curr_line());
+    ///     println!("line {:?}", debug.current_line());
     ///     Ok(VmState::Continue)
     /// });
     ///

tests/hooks.rs

@@ -24,7 +24,7 @@ fn test_line_counts() -> Result<()> {
     let lua = Lua::new();
     lua.set_hook(HookTriggers::EVERY_LINE, move |_lua, debug| {
         assert_eq!(debug.event(), DebugEvent::Line);
-        hook_output.lock().unwrap().push(debug.curr_line());
+        hook_output.lock().unwrap().push(debug.current_line().unwrap());
         Ok(VmState::Continue)
     })?;
     lua.load(
@@ -240,7 +240,7 @@ fn test_hook_threads() -> Result<()> {
     let hook_output = output.clone();
     co.set_hook(HookTriggers::EVERY_LINE, move |_lua, debug| {
         assert_eq!(debug.event(), DebugEvent::Line);
-        hook_output.lock().unwrap().push(debug.curr_line());
+        hook_output.lock().unwrap().push(debug.current_line().unwrap());
         Ok(VmState::Continue)
     })?;
 

tests/tests.rs

@@ -1283,7 +1283,7 @@ fn test_inspect_stack() -> Result<()> {
             .inspect_stack(1, |debug| {
                 let source = debug.source().short_src;
                 let source = source.as_deref().unwrap_or("?");
-                let line = debug.curr_line();
+                let line = debug.current_line().unwrap();
                 format!("{}:{} {}", source, line, msg)
             })
             .unwrap();