Skip to main content

HeapGuard

Struct HeapGuard 

Source
pub struct HeapGuard { /* private fields */ }
Expand description

A scoped guard for the currently-active heap. Pushed at entry to state.run() / state.protected_call() / state.load(); popped on drop. Supports nesting (multiple LuaStates on one thread).

Holds a strong Rc<Heap> on the TLS stack (issue #252): the guard is sound with no outlives contract — a guard that outlives its Lua keeps the heap alive until the guard pops, rather than dangling. Guards are function-scoped everywhere in-tree, so the lifetime extension is transient by construction.

!Send/!Sync (via the Rc it carries): the stack it pops lives in this thread’s TLS, so moving a guard to another thread would pop the wrong stack. The guard keeps its own copy of the heap handle so Drop can assert it pops the frame it pushed.

Implementations§

Source§

impl HeapGuard

Source

pub fn push(heap: &Rc<Heap>) -> Self

Push heap onto the active stack. Returns a guard; dropping it pops.

Trait Implementations§

Source§

impl Drop for HeapGuard

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.