[][src]Trait artichoke_backend::gc::MrbGarbageCollection

pub trait MrbGarbageCollection {
    pub fn create_arena_savepoint(
        &mut self
    ) -> Result<ArenaIndex<'_>, ArenaSavepointError>;
pub fn live_object_count(&mut self) -> i32;
pub fn mark_value(&mut self, value: &Value);
pub fn incremental_gc(&mut self);
pub fn full_gc(&mut self);
pub fn enable_gc(&mut self) -> State;
pub fn disable_gc(&mut self) -> State; }

Garbage collection primitives for an mruby interpreter.

Required methods

pub fn create_arena_savepoint(
    &mut self
) -> Result<ArenaIndex<'_>, ArenaSavepointError>
[src]

Create a savepoint in the GC arena.

Savepoints allow mruby to deallocate all of the objects created via the C API.

Normally objects created via the C API are marked as permanently alive ("white" GC color) with a call to mrb_gc_protect.

The returned ArenaIndex implements Drop, so it is sufficient to let it go out of scope to ensure objects are eventually collected.

pub fn live_object_count(&mut self) -> i32[src]

Retrieve the number of live objects on the interpreter heap.

A live object is reachable via top self, the stack, or the arena.

pub fn mark_value(&mut self, value: &Value)[src]

Mark a Value as reachable in the mruby garbage collector.

pub fn incremental_gc(&mut self)[src]

Perform an incremental garbage collection.

An incremental GC is less computationally expensive than a full GC, but does not guarantee that all dead objects will be reaped. You may wish to use an incremental GC if you are operating with an interpreter in a loop.

pub fn full_gc(&mut self)[src]

Perform a full garbage collection.

A full GC guarantees that all dead objects will be reaped, so it is more expensive than an incremental GC. You may wish to use a full GC if you are memory constrained.

pub fn enable_gc(&mut self) -> State[src]

Enable garbage collection.

Returns the prior GC enabled state.

pub fn disable_gc(&mut self) -> State[src]

Disable garbage collection.

Returns the prior GC enabled state.

Loading content...

Implementors

impl MrbGarbageCollection for Artichoke[src]

Loading content...