Struct Engine 

pub struct Engine { /* private fields */ }

The public embedding API for the Ion interpreter.

Implementations

impl Engine

pub fn new() -> Self

pub fn with_output<H>(output: H) -> Self

where H: OutputHandler + 'static,

Create an engine with a host-provided output handler for io::print*.

pub fn with_output_handler(output: Arc<dyn OutputHandler>) -> Self

Create an engine with a shared host-provided output handler.

pub fn eval(&mut self, source: &str) -> Result<Value, IonError>

Evaluate a script, returning the last expression’s value.

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

Inject a value into the script scope.

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

Read a variable from the script scope.

pub fn get_all(&self) -> HashMap<String, Value>

Get all top-level bindings.

pub fn set_limits(&mut self, limits: Limits)

Set execution limits.

pub fn set_output<H>(&mut self, output: H)

where H: OutputHandler + 'static,

Set the host output handler used by io::print, io::println, and io::eprintln.

pub fn set_output_handler(&mut self, output: Arc<dyn OutputHandler>)

Set a shared host output handler used by io::print*.

pub fn register_fn( &mut self, name: &str, func: fn(&[Value]) -> Result<Value, String>, )

Register a built-in function.

pub fn register_closure<F>(&mut self, name: &str, func: F)

where F: Fn(&[Value]) -> Result<Value, String> + Send + Sync + 'static,

Register a built-in backed by a closure. Unlike register_fn, this accepts any Fn — including closures that capture host-side state such as a tokio::runtime::Handle, a database pool, or shared counters. See docs/concurrency.md for the tokio embedding pattern.

pub fn register_struct(&mut self, def: HostStructDef)

Register a host struct type that scripts can construct and match on.

pub fn register_enum(&mut self, def: HostEnumDef)

Register a host enum type that scripts can construct and match on.

pub fn register_module(&mut self, module: Module)

Register a module that scripts can access via module::name or use module::*.

pub fn register_type<T: IonType>(&mut self)

Register a type via the IonType trait (used with #[derive(IonType)]).

pub fn set_typed<T: IonType>(&mut self, name: &str, value: &T)

Inject a typed Rust value into the script scope.

pub fn get_typed<T: IonType>(&self, name: &str) -> Result<T, String>

Extract a typed Rust value from the script scope.

pub fn vm_eval(&mut self, source: &str) -> Result<Value, IonError>

Evaluate a script via the bytecode VM. Falls back to tree-walk for unsupported features (concurrency).

Trait Implementations

impl Default for Engine

fn default() -> Self

Returns the “default value” for a type.