Struct Script 

pub struct Script {
    pub engine: Engine,
    pub ctx: Scope<'static>,
}

Available on crate feature rhai only.

Rhai engine + evaluation scope.

Create with Script::new_bare, register extra functions on engine if needed, then evaluate files or snippets. See crate docs for the list of built-in helpers.

Fields

engine: Engine

The Rhai engine (register extra fns here before evaluating).

ctx: Scope<'static>

Persistent scope (variables set via Script::set_dynamic).

Implementations

impl Script

pub fn new_bare(resolver_path: Vec<String>) -> Script

Create a new engine with generic helpers registered and resolver_path added to the module resolver. resolver_path is a list of directories searched by import statements.

let mut s = vynil_core::engine::Script::new_bare(vec![]);
assert_eq!(s.eval("sha256(\"hello\")").unwrap().into_string().unwrap(),
    "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824");

pub fn add_common(&mut self)

Inject assert and import_run/import_template shims (called by new_bare).

pub fn add_code(&mut self, code: &str)

Compile code and register its public functions as global Rhai modules. Errors are logged via tracing::error! and otherwise ignored.

pub fn set_dynamic(&mut self, name: &str, val: &Value)

Push a JSON value into the persistent Rhai scope under name.

pub fn run_file(&mut self, file: &PathBuf) -> Result<Dynamic, Error>

Evaluate the Rhai file at file inside the persistent scope.

pub fn eval(&mut self, script: &str) -> Result<Dynamic, Error>

Evaluate a Rhai snippet and return its Dynamic result.

pub fn eval_truth(&mut self, script: &str) -> Result<bool, Error>

Evaluate a Rhai snippet expected to return bool.

pub fn eval_map_string(&mut self, script: &str) -> Result<String, Error>

Evaluate a Rhai snippet expected to return a Map, serialised to a JSON string.

pub fn eval_map_json(&mut self, script: &str) -> Result<Value, Error>

Evaluate a Rhai snippet expected to return a Map, as serde_json::Value.

Trait Implementations

impl Debug for Script

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

Formats the value using the given formatter.