Struct boa_engine::script::Script

pub struct Script { /* private fields */ }

ECMAScript’s Script Record.

Implementations

impl Script

pub fn realm(&self) -> &Realm

Gets the realm of this script.

pub fn host_defined(&self) -> &HostDefined

Returns the ECMAScript specification defined \[\[HostDefined\]\] field of the Module.

pub fn parse<R: ReadChar>( src: Source<'_, R>, realm: Option<Realm>, context: &mut Context ) -> JsResult<Self>

Abstract operation ParseScript ( sourceText, realm, hostDefined ).

Parses the provided src as an ECMAScript script, returning an error if parsing fails.

pub fn codeblock(&self, context: &mut Context) -> JsResult<Gc<CodeBlock>>

Compiles the codeblock of this script.

This is a no-op if this has been called previously.

pub fn evaluate(&self, context: &mut Context) -> JsResult<JsValue>

Evaluates this script and returns its result.

Note that this won’t run any scheduled promise jobs; you need to call Context::run_jobs on the context or JobQueue::run_jobs on the provided queue to run them.

pub async fn evaluate_async(&self, context: &mut Context) -> JsResult<JsValue>

Evaluates this script and returns its result, periodically yielding to the executor in order to avoid blocking the current thread.

This uses an implementation defined amount of “clock cycles” that need to pass before execution is suspended. See Script::evaluate_async_with_budget if you want to also customize this parameter.

pub async fn evaluate_async_with_budget( &self, context: &mut Context, budget: u32 ) -> JsResult<JsValue>

Evaluates this script and returns its result, yielding to the executor each time budget number of “clock cycles” pass.

Note that “clock cycle” is in quotation marks because we can’t determine exactly how many CPU clock cycles a VM instruction will take, but all instructions have a “cost” associated with them that depends on their individual complexity. We’d recommend benchmarking with different budget sizes in order to find the ideal yielding time for your application.

Trait Implementations

impl Clone for Script

fn clone(&self) -> Script

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Script

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

Formats the value using the given formatter.

impl Drop for Script

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for Script

fn finalize(&self)

Cleanup logic for a type.

impl Trace for Script

unsafe fn trace(&self, tracer: &mut Tracer)

Marks all contained Gcs.

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root.

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.