Struct spaik::nkgc::Arena

pub struct Arena<'a> { /* fields omitted */ }

Come and fight in the arena!

Implementations

impl<'a> Arena<'a>

pub fn new<'b>(memsz: usize) -> Arena<'b>

pub fn print_state(&self)

pub fn minimize(&mut self)

pub fn dup(&mut self) -> Result<(), Error>

pub fn put<T>(&mut self, v: T) -> PV where
    T: Fissile, 

pub fn clz_expand(&mut self, idx: usize) -> Result<(), Error>

pub fn dump_stack(&self)

pub fn forbid_reordering(&mut self)

pub fn allow_reordering(&mut self)

pub fn stats(&self) -> GCStats

TODO: make used, sz, and num_atoms atomic. Then create a begin_profile(t, sz) method that spawns a thread which will save GCStats every t seconds until it reaches sz samples. stop_profile() -> Vec retrieves the stats.

  You'll have to figure out how to make atomic variables
  work across the FFI.

pub fn push_sym(&mut self, v: SymID)

pub fn push_env(&mut self, v: PV) -> usize

pub fn get_env(&self, idx: usize) -> PV

pub fn set_env(&mut self, idx: usize, v: PV)

pub fn push(&mut self, v: PV)

pub fn push_spv(&mut self, v: SPV<'a>)

pub fn popn(&mut self, n: usize)

pub fn stack_mut(&mut self) -> &mut Vec<PV>

pub fn list(&mut self, n: u32)

pub fn make_extref(&mut self, v: PV) -> SPV<'a>

pub fn get_ext(&self, id: u32) -> PV

pub unsafe fn drop_ext(&mut self, id: u32)

Drop an external reference

Arguments

• id : Reference ID

Safety

Using the reference after it has been dropped is UB.

pub fn pop_spv(&mut self) -> Result<SPV<'a>, Error>

pub fn pop(&mut self) -> Result<PV, Error>

pub fn top(&self) -> PV

pub fn peek(&self) -> Result<PV, RuntimeError>

pub fn untag_ast(&mut self, v: PV)

pub fn push_ast(&mut self, v: &Value) -> PV

pub fn append(&mut self, n: u32) -> Result<(), RuntimeError>

pub fn cons(&mut self)

pub unsafe fn cons_unchecked(&mut self)

Pop two elements off the stack and cons them together.

Safety

This function requires at least two values to be placed on the stack before it is called. If this requirement is not met the function will cause a buffer underflow read.

pub fn tag(&mut self, item: *mut NkAtom, tag: Source)

pub fn get_tag(&self, item: *mut NkAtom) -> Option<&Source>

pub fn untag(&mut self, item: *mut NkAtom)

pub fn push_new<T: Fissile>(&mut self, v: T)

pub fn collect(&mut self)

pub fn full_collection(&mut self)

Perform a full GC collection, this may finish a currently ongoing collection and start a new one afterwards.

pub fn ignore_and_sweep(&mut self)

Remove all allocated objects

Trait Implementations

impl<'a> Debug for Arena<'a>

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

Formats the value using the given formatter.

impl Default for Arena<'_>

fn default() -> Self

Returns the "default value" for a type.

impl Drop for Arena<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl SymDB for Arena<'_>

fn name(&self, sym: SymID) -> Cow<'_, str>

fn put(&mut self, name: &str) -> SymID