Struct Runtime 

pub struct Runtime { /* private fields */ }

One sandboxed realm.

Implementations

impl Runtime

pub fn builder() -> Builder

pub fn handle(&self) -> VmHandle

The realm’s event-loop handle. Cloneable; a host keeps one to dispatch into the VM from its own tasks.

pub fn config(&self) -> &Config

pub fn registry(&self) -> &Arc<ModuleRegistry>

pub fn permissions(&self) -> &Arc<Container>

pub fn poisoned(&self) -> bool

Whether a run left the heap untrustworthy. Once set it stays set; the host discards the realm.

pub fn deadline(&self) -> Deadline

A cloneable handle to the run deadline, for a host that re-arms it from somewhere the runtime itself cannot be held.

pub async fn with<R, F>(&self, f: F) -> Result<R, ScriptError>

where R: Send + 'static, F: for<'js> FnOnce(Ctx<'js>) -> Pin<Box<dyn Future<Output = R> + Send + 'js>> + Send + 'static,

Run f on the VM loop with the context in scope, outside any run bracket: no deadline, no console capture, no poison detection. For installs and lookups, not for user code.

Errors

Only when the loop is gone (the realm was dropped).

pub async fn run<T: Send + 'static>( &self, options: RunOptions, body: RunBody<T>, ) -> Run<T>

Run body under the run bracket: limits applied, the deadline armed, a fresh console capture installed, the backstop watching, and the outcome classified (a force-halt or an allocation fault poisons the realm; a throw does not).

The body sees the context with console already refreshed. Its value and failure are redacted before they are handed back.

pub async fn eval_script( &self, source: &str, args: &[Value], options: RunOptions, ) -> Run<Value>

Evaluate a script with args bound as the args global, and answer its top-level return value as JSON.

The source is wrapped in an async IIFE, so await works at the top level and return <value> surfaces as the result. args is never interpolated into the source. For an ES module (import / export, TypeScript) bundle it and use Self::eval_module.

pub async fn eval_module( &self, module: &CompiledModule, args: &[Value], options: RunOptions, ) -> Run<Value>

Evaluate a precompiled ES module with args bound as the args global. A module cannot use top-level return, so the run’s value is the module’s default export (null when it has none). Error positions are remapped through the module’s source map.

pub fn redact_value(&self, value: &mut Value)

Replace redacted values in a JSON document the way the runtime does for its own results, for a host body that builds one.

pub async fn eval_module_source( &self, name: &str, source: &str, args: &[Value], options: RunOptions, ) -> Run<Value>

Declare and evaluate an ES module from source, under name, with args bound. For a host without a bundler, or a test.

Trait Implementations

impl Debug for Runtime

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

Formats the value using the given formatter.