Struct ScriptHost 

pub struct ScriptHost { /* private fields */ }

High-level scripting host. Owns the VM and provides ergonomic registration APIs.

Implementations

impl ScriptHost

pub fn new() -> Self

Create a new ScriptHost with the standard library pre-registered.

pub fn sandboxed() -> Self

Create a sandboxed host with no standard library.

pub fn register<F>(&mut self, name: &str, f: F)

where F: Fn(&mut Vm, Vec<Value>) -> Result<Vec<Value>, ScriptError> + Send + Sync + 'static,

Register a Rust closure as a global script function.

pub fn register_fn<F>(&mut self, name: &str, f: F)

where F: Fn(Vec<Value>) -> Result<Vec<Value>, ScriptError> + Send + Sync + 'static,

Register a simple 1-argument Rust function.

pub fn set(&mut self, name: &str, value: Value)

Set a global variable.

pub fn get(&self, name: &str) -> Value

Get a global variable.

pub fn register_module(&mut self, name: &str, funcs: Vec<(&str, HostFunction)>)

Expose a Rust table of functions as a named module.

host.register_module("engine", vec![
    ("spawn", Arc::new(|_vm, args| { ... })),
]);

pub fn exec(&mut self, source: &str) -> Result<Vec<Value>, ScriptError>

Execute a script string, returning all return values.

pub fn exec_named( &mut self, name: &str, source: &str, ) -> Result<Vec<Value>, ScriptError>

Execute a named script (for better error messages).

pub fn call( &mut self, func_name: &str, args: Vec<Value>, ) -> Result<Vec<Value>, ScriptError>

Call a previously defined script function by name.

pub fn call_method( &mut self, table_name: &str, method_name: &str, args: Vec<Value>, ) -> Result<Vec<Value>, ScriptError>

Call a method on a table: table_name.method_name(args).

pub fn get_int(&self, name: &str) -> Option<i64>

Get a global as an integer.

pub fn get_float(&self, name: &str) -> Option<f64>

Get a global as a float.

pub fn get_string(&self, name: &str) -> Option<String>

Get a global as a string.

pub fn get_bool(&self, name: &str) -> Option<bool>

Get a global as a boolean.

pub fn drain_output(&mut self) -> Vec<String>

Drain all lines produced by print() calls.

pub fn vm(&mut self) -> &mut Vm

Access the underlying VM directly.

Trait Implementations

impl Default for ScriptHost

fn default() -> Self

Returns the “default value” for a type.