Struct hlua::PushGuard

pub struct PushGuard<L> { /* private fields */ }

RAII guard for a value pushed on the stack.

You shouldn’t have to manipulate this type directly unless you are fiddling with the library’s internals.

Implementations

impl<'lua, L> PushGuard<L>

where L: AsMutLua<'lua>,

pub unsafe fn new(lua: L, size: i32) -> Self

Creates a new PushGuard from this Lua context representing size items on the stack. When this PushGuard is destroyed, size items will be popped.

This is unsafe because the Lua stack can be corrupted if this is misused.

pub fn size(&self) -> i32

Returns the number of elements managed by this PushGuard.

pub unsafe fn forget(self) -> i32

Prevents the value from being popped when the PushGuard is destroyed, and returns the number of elements on the Lua stack.

This is unsafe because the Lua stack can be corrupted if this is misused.

pub fn into_inner(self) -> L

Destroys the guard, popping the value. Returns the inner part, which returns access when using by-value capture.

Trait Implementations

impl<'lua, L> AsLua<'lua> for PushGuard<L>

where L: AsMutLua<'lua>,

fn as_lua(&self) -> LuaContext

impl<'lua, L> AsMutLua<'lua> for PushGuard<L>

where L: AsMutLua<'lua>,

fn as_mut_lua(&mut self) -> LuaContext

Returns the raw Lua context.

impl<L: Debug> Debug for PushGuard<L>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<L> Drop for PushGuard<L>

fn drop(&mut self)

Executes the destructor for this type.