Struct koto_runtime::KotoVm

pub struct KotoVm { /* private fields */ }

The Koto runtime’s virtual machine

Implementations

impl KotoVm

pub fn with_settings(settings: KotoVmSettings) -> Self

Initializes a Koto VM with the provided settings

pub fn spawn_shared_vm(&self) -> Self

Spawn a VM that shares the same execution context

e.g.

• An iterator spawns a shared VM that can be used to execute functors
• A generator function spawns a shared VM to yield incremental results
• Thrown errors spawn a shared VM to display an error from a custom error type

pub fn loader(&self) -> &KCell<Loader>

The loader, responsible for loading and compiling Koto scripts and modules

pub fn prelude(&self) -> &KMap

The prelude, containing items that can be imported within all modules

pub fn exports(&self) -> &KMap

The active module’s exports map

Note that this is the exports map of the active module, so during execution the returned map will be of the module that’s currently being executed.

pub fn exports_mut(&mut self) -> &mut KMap

Returns a mutable reference to the active module’s exports map

pub fn stdin(&self) -> &Ptr<dyn KotoFile>

The stdin wrapper used by the VM

pub fn stdout(&self) -> &Ptr<dyn KotoFile>

The stdout wrapper used by the VM

pub fn stderr(&self) -> &Ptr<dyn KotoFile>

The stderr wrapper used by the VM

pub fn run(&mut self, chunk: Ptr<Chunk>) -> Result<KValue>

Runs the provided Chunk, returning the resulting KValue

pub fn continue_running(&mut self) -> Result<ReturnOrYield>

Continues execution in a suspended VM

This is currently used to support generators, which yield incremental results and then leave the VM in a suspended state.

pub fn call_function<'a>( &mut self, function: KValue, args: impl Into<CallArgs<'a>> ) -> Result<KValue>

Calls a function with some given arguments

pub fn call_instance_function<'a>( &mut self, instance: KValue, function: KValue, args: impl Into<CallArgs<'a>> ) -> Result<KValue>

Runs an instance function with some given arguments

pub fn value_to_string(&mut self, value: &KValue) -> Result<String>

Returns a displayable string for the given value

pub fn run_unary_op(&mut self, op: UnaryOp, value: KValue) -> Result<KValue>

Provides the result of running a unary operation on a KValue

pub fn run_binary_op( &mut self, op: BinaryOp, lhs: KValue, rhs: KValue ) -> Result<KValue>

Provides the result of running a binary operation on a pair of Values

pub fn make_iterator(&mut self, value: KValue) -> Result<KIterator>

Makes a KIterator that iterates over the provided value’s contents

pub fn run_tests(&mut self, tests: KMap) -> Result<KValue>

Runs any tests that are contained in the map’s @tests meta entry

Any test failure will be returned as an error.

pub fn chunk(&self) -> Ptr<Chunk>

The bytecode chunk currently active in the VM

Trait Implementations

impl Clone for KotoVm

fn clone(&self) -> KotoVm

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KotoVm

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

Formats the value using the given formatter.

impl Default for KotoVm

fn default() -> Self

Returns the “default value” for a type.