Struct spaik::Spaik

pub struct Spaik { /* private fields */ }

A SPAIK Context, this is the main way to use SPAIK

Implementations

impl Spaik

pub fn new() -> Spaik

Create a new SPAIK VM

pub fn new_no_core() -> Spaik

Create a new SPAIK VM

pub fn register(&mut self, func: impl Subr)

Register a subroutine (function) with the vm

pub fn set(&mut self, var: impl AsSym, obj: impl IntoLisp)

Move obj into the vm as var.

pub fn get<R>(&mut self, var: impl AsSym) -> Result<R>where PV: FromLisp<R>,

Return a clone of var

pub unsafe fn objref<T>(&mut self, var: impl AsSym) -> Result<*const T>where T: Userdata,

Get a reference to a user-defined object type stored in the vm.

Arguments

• var : Variable name

Safety

The returned pointer may not be dereferenced after a garbage-collection cycle runs, which also means that no SPAIK code may run on this VM before the pointer is dereferenced. A gc cycle may leave the returned pointer dangling.

Safe Alternative

Use Gc<T>, like this:

use spaik::prelude::*;
use spaik::ExampleObject;
let mut vm = Spaik::new_no_core();
vm.set("obj", ExampleObject { x: 1.0, y: 3.3 });
let mut obj: Gc<ExampleObject> = vm.get("obj").unwrap();
assert_eq!(obj.with(|r| (r.x, r.y)), (1.0, 3.3));

pub fn obj<T: Userdata>(&mut self, var: impl AsSym) -> Result<T>

Get a clone of a user-defined object type stored in the vm.

pub unsafe fn objref_mut<T>(&mut self, var: impl AsSym) -> Result<*mut T>where T: Userdata,

Retrieve a variable as a mutable reference.

Arguments

• var : Variable name

Safety

The returned pointer may not be dereferenced after a garbage-collection cycle runs, which also means that no SPAIK code may run on this VM before the pointer is dereferenced. A gc cycle may leave the returned pointer dangling.

Safe Alternative

Use Gc<T>, like this:

use spaik::prelude::*;
use spaik::ExampleObject;
let mut vm = Spaik::new_no_core();
vm.set("obj", ExampleObject { x: 1.0, y: 3.3 });
let mut obj: Gc<ExampleObject> = vm.get("obj").unwrap();
assert_eq!(obj.with(|r| (r.x, r.y)), (1.0, 3.3));

pub fn eval<R>(&mut self, expr: impl AsRef<str>) -> Result<R>where PV: FromLisp<R>,

Run an expression.

Arguments

• expr : Lisp expression

pub fn exec(&mut self, expr: impl AsRef<str>) -> Result<()>

Run an expression and ignore the result (unless there was an error.)

Arguments

• expr : Lisp expression

pub fn trace_report(&self)

pub fn load(&mut self, lib: impl AsSym) -> Result<SymRef>

Load library from the load-path, by default this is ./lisp/.

Arguments

• lib : If the library is stored at "<name>.lisp", then lib should be <name> as either a string or symbol

pub fn load_with<S>(&mut self, _src_path: S, _lib: Sym, _code: S) -> Result<Sym>where S: AsRef<str>,

Load a SPAIK library from a string, this is useful both for embedding code into your binary with e.g load_with(x, y, include_str!(...)) or when loading from a virtual filesystem.

Arguments

• src_path : File-system path to the .lisp file, needed for source-file/line error messages.
• lib : Library symbol name, i.e the argument to (load ...)
• code : The source-code contents inside src_path

pub fn query<R>(&mut self, enm: impl EnumCall) -> Result<R>where PV: FromLisp<R>,

Call a function by-enum and return the result

Use Spaik::cmd if don’t care about the result.

pub fn cmd(&mut self, enm: impl EnumCall) -> Result<()>

Call a function by-enum and ignore the result

Use Spaik::query if you need the result.

pub fn call<R>(&mut self, sym: impl AsSym, args: impl Args) -> Result<R>where PV: FromLisp<R>,

Call a function by-name an args and return the result.

Use Spaik::run if don’t care about the result.

pub fn run(&mut self, sym: impl AsSym, args: impl Args) -> Result<()>

Call a function by-name an args and ignore the result.

Use Spaik::call if you need the result.

pub fn gc(&mut self)

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

pub fn fulfil<R, A, T>(&mut self, pr: Promise<T>, ans: A) -> Result<R>where PV: FromLisp<R>, A: IntoLisp + Clone + Send + 'static,

Fulfil a Promise<T> by running its continuation with value ans

pub fn add_load_path(&mut self, path: impl AsRef<str>)

Add to load path, this influences where Spaik::load will search for spaik files.

Panics

Panics if the sys/load-path variable is not defined, or is not a vector.

pub fn fork<T, Cmd>(self) -> SpaikPlug<T, Cmd>where T: DeserializeOwned + Send + Debug + Clone + 'static, Cmd: EnumCall + Send + 'static,

Move the VM off-thread and return a SpaikPlug handle for IPC.

Trait Implementations

impl Default for Spaik

fn default() -> Self

Returns the “default value” for a type.