Struct mlua::Debug

pub struct Debug<'lua> { /* private fields */ }

Contains information about currently executing Lua code.

The Debug structure is provided as a parameter to the hook function set with Lua::set_hook. You may call the methods on this structure to retrieve information about the Lua code executing at the time that the hook function was called. Further information can be found in the Lua documentation.

Implementations

impl<'lua> Debug<'lua>

pub fn event(&self) -> DebugEvent

Available on non-crate feature luau only.

Returns the specific event that triggered the hook.

For Lua 5.1 DebugEvent::TailCall is used for return events to indicate a return from a function that did a tail call.

pub fn names(&self) -> DebugNames<'_>

Corresponds to the n what mask.

pub fn source(&self) -> DebugSource<'_>

Corresponds to the S what mask.

pub fn curr_line(&self) -> i32

Corresponds to the l what mask. Returns the current line.

pub fn is_tail_call(&self) -> bool

Available on non-crate feature luau only.

Corresponds to the t what mask. Returns true if the hook is in a function tail call, false otherwise.

pub fn stack(&self) -> DebugStack

Corresponds to the u what mask.