Struct Vm

pub struct Vm { /* private fields */ }

The Spore virtual machine.

Example

let mut vm = spore_vm::Vm::default();
vm.eval_str("(define foo 42)").unwrap();
let foo = vm.val_by_name("foo").unwrap().try_int().unwrap(); // 42
vm.eval_str("(define (bar x) (+ x foo))").unwrap();
let bar_10 = vm
    .eval_function_by_name("bar", std::iter::once(10.into()))
    .unwrap()
    .try_int()
    .unwrap(); // 52

Implementations

impl Vm

pub fn new(settings: Settings) -> Vm

Create a new virtual machine.

pub fn with_native_function(self, name: &str, func: NativeFunction) -> Self

Return the VM with the native function registered.

pub fn with_custom_value(self, name: &str, val: impl CustomType) -> Self

Return the VM with a custom value that is accessible globally.

Example

#[derive(Debug, Default)]
pub struct MyType(i64);
impl spore_vm::val::CustomType for MyType {}
impl std::fmt::Display for MyType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "my number is {}", self.0)
    }
}

let mut vm = spore_vm::Vm::default()
    .with_custom_value("my_value", MyType(10));
let val = vm.val_by_name("my_value").unwrap();
let mut custom_val = val.try_custom_mut::<MyType>(&vm).unwrap();
custom_val.0 = 100;

pub fn with(self, f: impl Fn(Vm) -> Vm) -> Self

Return the VM returned by calling fn.

impl Vm

pub fn val_by_name(&self, name: &str) -> Option<Val<'_>>

Get the value with the given name or None if it does not exist.

pub fn eval_str(&mut self, source: &str) -> VmResult<ProtectedVal<'_>>

Evaluate a string in the virtual machine.

let mut vm = spore_vm::Vm::default();
let x = vm.eval_str("(+ 20 22)").unwrap().try_int().unwrap();

pub fn eval_function_by_name( &mut self, name: &str, args: impl ExactSizeIterator<Item = Val<'static>>, ) -> VmResult<ProtectedVal<'_>>

Call a function with the given name.

let mut vm = spore_vm::Vm::default();
vm.eval_str("(define (fib n) (if (< n 2) n (+ (fib (+ n -1)) (fib (+ n -2)))))")
    .unwrap();
let ans = vm
    .eval_function_by_name("fib", std::iter::once(10.into()))
    .unwrap()
    .try_int()
    .unwrap();

impl Vm

pub unsafe fn run_gc(&mut self)

Run the garbage collector.

This does not need to be manually invoked as it is called automatically at the start of evaluation through functions like Self::eval_str and Self::eval_function_by_name.

Safety

impl Vm

pub fn get_symbol(&self, s: &str) -> Option<Symbol>

Get the symbol for the given s, or None if it does not exist within the VM.

pub fn get_or_create_symbol(&mut self, s: &str) -> Symbol

Get the given symbol within the VM or create it if it does not exist.

pub fn symbol_to_str(&self, s: Symbol) -> Option<&str>

Get the str representation for a symbol.

Trait Implementations

impl Debug for Vm

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

Formats the value using the given formatter.

impl Default for Vm

fn default() -> Vm

Create a new virtual machine.

impl Drop for Vm

fn drop(&mut self)

Executes the destructor for this type.