Struct boa_engine::module::Module

pub struct Module { /* private fields */ }

ECMAScript’s Abstract module record.

Implementations

impl Module

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

Abstract operation ParseModule ( sourceText, realm, hostDefined ).

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

pub fn synthetic( export_names: &[JsString], evaluation_steps: SyntheticModuleInitializer, realm: Option<Realm>, context: &mut Context ) -> Self

Abstract operation CreateSyntheticModule ( exportNames, evaluationSteps, realm ).

Creates a new Synthetic Module from its list of exported names, its evaluation steps and optionally a root realm.

pub fn realm(&self) -> &Realm

Gets the realm of this Module.

pub fn host_defined(&self) -> &HostDefined

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

pub fn load(&self, context: &mut Context) -> JsPromise

Abstract method LoadRequestedModules ( [ hostDefined ] ).

Prepares the module for linking by loading all its module dependencies. Returns a JsPromise that will resolve when the loading process either completes or fails.

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

Abstract method Link() .

Prepares this module for evaluation by resolving all its module dependencies and initializing its environment.

Note

This must only be called if the JsPromise returned by Module::load has fulfilled.

pub fn evaluate(&self, context: &mut Context) -> JsPromise

Abstract method Evaluate().

Evaluates this module, returning a promise for the result of the evaluation of this module and its dependencies. If the promise is rejected, hosts are expected to handle the promise rejection and rethrow the evaluation error.

Note

This must only be called if the Module::link method finished successfully.

pub fn load_link_evaluate(&self, context: &mut Context) -> JsPromise

Loads, links and evaluates this module, returning a promise that will resolve after the module finishes its lifecycle.

Examples

let loader = Rc::new(SimpleModuleLoader::new(Path::new(".")).unwrap());
let mut context = &mut Context::builder()
    .module_loader(loader.clone())
    .build()
    .unwrap();

let source = Source::from_bytes("1 + 3");

let module = Module::parse(source, None, context).unwrap();

loader.insert(Path::new("main.mjs").to_path_buf(), module.clone());

let promise = module.load_link_evaluate(context);

context.run_jobs();

assert_eq!(
    promise.state(),
    PromiseState::Fulfilled(JsValue::undefined())
);

pub fn namespace(&self, context: &mut Context) -> JsObject

Abstract operation GetModuleNamespace ( module ).

Gets the Module Namespace Object that represents this module’s exports.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Drop for Module

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for Module

fn finalize(&self)

Cleanup logic for a type.

impl Hash for Module

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Module

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Trace for Module

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.

impl Eq for Module