gc_collect_cycles()

gc_collect_cycles()

function gc_collect_cycles(): int

Forces collection of any existing garbage cycles.

Parameters: none.

Returns: int

Availability

• Compiled (AOT): supported by the Elephc code generator.
• eval() (magician interpreter): supported through a declarative interpreter builtin (crates/elephc-magician/src/interpreter/builtins/core/gc_collect_cycles.rs).

No examples yet. Check examples/ and showcases/ for usage patterns.

Internals

For how gc_collect_cycles is implemented in the compiler, see the internals page.