Struct stk::Vm

pub struct Vm { /* fields omitted */ }

A stack which references variables indirectly from a slab.

Implementations

impl Vm

pub fn new() -> Self

Construct a new stk virtual machine.

pub fn clear(&mut self)

Reset this virtual machine, freeing all memory used.

pub fn ip(&self) -> usize

Access the current instruction pointer.

pub fn modify_ip(&mut self, offset: isize) -> Result<(), VmError>

Modify the current instruction pointer.

pub fn iter_stack_debug(
    &self
) -> impl Iterator<Item = (ValuePtr, Result<ValueRef, StackError>)> + '_

Iterate over the stack, producing the value associated with each stack item.

pub fn call_function<'a, A: 'a, T, I>(
    &'a mut self,
    context: &'a Context,
    unit: &'a CompilationUnit,
    name: I,
    args: A
) -> Result<Task<'a, T>, VmError> where
    I: IntoIterator,
    I::Item: AsRef<str>,
    A: IntoArgs,
    T: FromValue, 

Call the given function in the given compilation unit.

pub fn run<'a, T>(
    &'a mut self,
    context: &'a Context,
    unit: &'a CompilationUnit
) -> Task<'a, T> where
    T: FromValue, 

Run the given program on the virtual machine.

pub fn push(&mut self, value: ValuePtr)

Push an unmanaged reference.

The reference count of the value being referenced won't be modified.

pub fn pop(&mut self) -> Result<ValuePtr, StackError>

Pop a reference to a value from the stack.

pub fn external_allocate<T>(&mut self, value: T) -> ValuePtr where
    T: Any, 

Allocate and insert an external and return its reference.

This will leak memory unless the reference is pushed onto the stack to be managed.

pub unsafe fn external_allocate_ptr<T>(&mut self, value: *const T) -> ValuePtr where
    T: Any, 

Allocate an external slot for the given reference.

Safety

If the pointer was constructed from a reference, the reference passed in MUST NOT be used again until the VM has been cleared using clear since the VM is actively aliasing the reference for the duration of its life.

pub unsafe fn external_allocate_mut_ptr<T>(&mut self, value: *mut T) -> ValuePtr where
    T: Any, 

Allocate an external slot for the given mutable reference.

Safety

If the pointer was constructed from a reference, the reference passed in MUST NOT be used again until the VM has been cleared using clear since the VM is actively aliasing the reference for the duration of its life.

pub fn string_allocate(&mut self, value: String) -> ValuePtr

Allocate a value and return its ptr.

This operation can leak memory unless the returned slot is pushed onto the stack.

Newly allocated items already have a refcount of 1. And should be pushed on the stack using [push], rather than [push.

pub fn string_ref(&self, slot: Slot) -> Result<Ref<String>, StackError>

Get a reference of the value at the given slot.

pub fn string_clone(&self, slot: Slot) -> Result<String, StackError>

Get a cloned value from the given slot.

pub fn string_mut(&self, slot: Slot) -> Result<Mut<String>, StackError>

Get a reference of the value at the given slot.

pub fn string_take(&mut self, slot: Slot) -> Result<String, StackError>

Take the value at the given slot.

After taking the value, the caller is responsible for deallocating it.

pub fn array_allocate(&mut self, value: Vec<ValuePtr>) -> ValuePtr

Allocate a value and return its ptr.

This operation can leak memory unless the returned slot is pushed onto the stack.

Newly allocated items already have a refcount of 1. And should be pushed on the stack using [push], rather than [push.

pub fn array_ref(&self, slot: Slot) -> Result<Ref<Vec<ValuePtr>>, StackError>

Get a reference of the value at the given slot.

pub fn array_clone(&self, slot: Slot) -> Result<Vec<ValuePtr>, StackError>

Get a cloned value from the given slot.

pub fn array_mut(&self, slot: Slot) -> Result<Mut<Vec<ValuePtr>>, StackError>

Get a reference of the value at the given slot.

pub fn array_take(&mut self, slot: Slot) -> Result<Vec<ValuePtr>, StackError>

Take the value at the given slot.

After taking the value, the caller is responsible for deallocating it.

pub fn object_allocate(&mut self, value: HashMap<String, ValuePtr>) -> ValuePtr

Allocate a value and return its ptr.

This operation can leak memory unless the returned slot is pushed onto the stack.

Newly allocated items already have a refcount of 1. And should be pushed on the stack using [push], rather than [push.

pub fn object_ref(
    &self,
    slot: Slot
) -> Result<Ref<HashMap<String, ValuePtr>>, StackError>

Get a reference of the value at the given slot.

pub fn object_clone(
    &self,
    slot: Slot
) -> Result<HashMap<String, ValuePtr>, StackError>

Get a cloned value from the given slot.

pub fn object_mut(
    &self,
    slot: Slot
) -> Result<Mut<HashMap<String, ValuePtr>>, StackError>

Get a reference of the value at the given slot.

pub fn object_take(
    &mut self,
    slot: Slot
) -> Result<HashMap<String, ValuePtr>, StackError>

Take the value at the given slot.

After taking the value, the caller is responsible for deallocating it.

pub fn external_ref<T>(&self, slot: Slot) -> Result<Ref<T>, StackError> where
    T: Any, 

Get a reference of the external value of the given type and the given slot.

pub fn external_mut<T>(&self, slot: Slot) -> Result<Mut<T>, StackError> where
    T: Any, 

Get a mutable reference of the external value of the given type and the given slot.

Mark the given value as mutably used, preventing it from being used again.

pub fn external_clone<T: Clone + Any>(
    &self,
    slot: Slot
) -> Result<T, StackError>

Get a clone of the given external.

pub fn external_take<T>(&mut self, slot: Slot) -> Result<T, StackError> where
    T: Any, 

Take an external value from the virtual machine by its slot.

pub fn external_ref_dyn(&self, slot: Slot) -> Result<Ref<Any>, StackError>

Get a reference of the external value of the given type and the given slot.

pub fn external_take_dyn(&mut self, slot: Slot) -> Result<Any, StackError>

Take an external value by dyn, assuming you have exlusive access to it.

pub fn slot_type_name(&self, slot: Slot) -> Result<&'static str, StackError>

Access the type name of the slot.

pub fn slot_type_id(&self, slot: Slot) -> Result<TypeId, StackError>

Access the type id of the slot.

pub fn value_take(&mut self, value: ValuePtr) -> Result<Value, StackError>

Convert a value reference into an owned value.

pub fn value_ref(&self, value: ValuePtr) -> Result<ValueRef, StackError>

Convert the given ptr into a type-erase ValueRef.

pub fn value_array_ref(
    &self,
    values: &[ValuePtr]
) -> Result<Vec<ValueRef>, StackError>

Convert the given value pointers into an array.

pub fn value_object_ref(
    &self,
    object: &HashMap<String, ValuePtr>
) -> Result<HashMap<String, ValueRef>, StackError>

Convert the given value pointers into an array.

pub async fn run_for<'_, '_, '_>(
    &'_ mut self,
    context: &'_ Context,
    unit: &'_ CompilationUnit,
    __arg3: Option<usize>
) -> Result<(), VmError>

Evaluate a single instruction.

Trait Implementations

impl Debug for Vm

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

Formats the value using the given formatter.