Struct mruby::gc::ArenaIndex

pub struct ArenaIndex { /* fields omitted */ }

Arena savepoint that can be restored to ensure mruby objects are reaped.

mruby manages objects created via the C API in a memory construct called the arena. The arena is a stack and objects stored there are permanently alive to avoid having to track lifetimes externally to the interperter.

An ArenaIndex is an index to some position of the stack. When restoring an ArenaIndex, the stack pointer is moved. All objects beyond the pointer are no longer live and are eligible to be collected at the next GC.

ArenaIndex implements Drop, so letting it go out of scope is sufficient to ensure objects get collected eventually.

Methods

impl ArenaIndex

pub fn restore(self)

Restore the arena stack pointer to its prior index.

Trait Implementations

impl Drop for ArenaIndex

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for ArenaIndex

fn clone(&self) -> ArenaIndex

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArenaIndex

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

Formats the value using the given formatter.