Struct Module

#[repr(C)]
pub struct Module(/* private fields */);

A compiled JavaScript module.

Implementations

impl Module

pub fn get_status(&self) -> ModuleStatus

Returns the module’s current status.

pub fn get_exception(&self) -> Local<'_, Value>

For a module in kErrored status, this returns the corresponding exception.

pub fn get_module_requests(&self) -> Local<'_, FixedArray>

Returns the ModuleRequests for this module.

pub fn source_offset_to_location(&self, offset: int) -> Location

For the given source text offset in this module, returns the corresponding Location with line and column numbers.

pub fn get_identity_hash(&self) -> NonZeroI32

Returns the V8 hash value for this value. The current implementation uses a hidden property to store the identity hash.

The return value will never be 0. Also, it is not guaranteed to be unique.

pub fn script_id(&self) -> Option<int>

Returns the underlying script’s id.

The module must be a SourceTextModule and must not have an Errored status.

pub fn get_module_namespace(&self) -> Local<'_, Value>

Returns the namespace object of this module.

The module’s status must be at least kInstantiated.

pub fn instantiate_module<'a>( &self, scope: &mut HandleScope<'_>, callback: impl MapFnTo<ResolveModuleCallback<'a>>, ) -> Option<bool>

Instantiates the module and its dependencies.

Returns an empty Maybe if an exception occurred during instantiation. (In the case where the callback throws an exception, that exception is propagated.)

pub fn instantiate_module2<'a>( &self, scope: &mut HandleScope<'_>, callback: impl MapFnTo<ResolveModuleCallback<'a>>, source_callback: impl MapFnTo<ResolveSourceCallback<'a>>, ) -> Option<bool>

Instantiates the module and its dependencies.

Returns an empty Maybe if an exception occurred during instantiation. (In the case where the callback throws an exception, that exception is propagated.)

pub fn evaluate<'s>( &self, scope: &mut HandleScope<'s>, ) -> Option<Local<'s, Value>>

Evaluates the module and its dependencies.

If status is kInstantiated, run the module’s code. On success, set status to kEvaluated and return the completion value; on failure, set status to kErrored and propagate the thrown exception (which is then also available via |GetException|).

pub fn is_graph_async(&self) -> bool

Returns whether this module or any of its requested modules is async, i.e. contains top-level await.

The module’s status must be at least kInstantiated.

pub fn is_source_text_module(&self) -> bool

Returns whether the module is a SourceTextModule.

pub fn is_synthetic_module(&self) -> bool

Returns whether the module is a SyntheticModule.

pub fn create_synthetic_module<'s, 'a>( scope: &mut HandleScope<'s>, module_name: Local<'_, String>, export_names: &[Local<'_, String>], evaluation_steps: impl MapFnTo<SyntheticModuleEvaluationSteps<'a>>, ) -> Local<'s, Module>

Creates a new SyntheticModule with the specified export names, where evaluation_steps will be executed upon module evaluation. export_names must not contain duplicates. module_name is used solely for logging/debugging and doesn’t affect module behavior.

pub fn set_synthetic_module_export( &self, scope: &mut HandleScope<'_>, export_name: Local<'_, String>, export_value: Local<'_, Value>, ) -> Option<bool>

Set this module’s exported value for the name export_name to the specified export_value. This method must be called only on Modules created via create_synthetic_module. An error will be thrown if export_name is not one of the export_names that were passed in that create_synthetic_module call. Returns Some(true) on success, None if an error was thrown.

pub fn get_unbound_module_script<'s>( &self, scope: &mut HandleScope<'s>, ) -> Local<'s, UnboundModuleScript>

pub fn get_stalled_top_level_await_message( &self, scope: &mut HandleScope<'_>, ) -> Vec<(Local<'_, Module>, Local<'_, Message>)>

Search the modules requested directly or indirectly by the module for any top-level await that has not yet resolved. If there is any, the returned vector contains a tuple of the unresolved module and a message with the pending top-level await. An embedder may call this before exiting to improve error messages.

Methods from Deref<Target = Data>

pub fn is_big_int(&self) -> bool

Returns true if this data is a BigInt.

pub fn is_boolean(&self) -> bool

Returns true if this data is a Boolean.

pub fn is_context(&self) -> bool

Returns true if this data is a Context.

pub fn is_fixed_array(&self) -> bool

Returns true if this data is a FixedArray.

pub fn is_function_template(&self) -> bool

Returns true if this data is a FunctionTemplate.

pub fn is_module(&self) -> bool

Returns true if this data is a Module.

pub fn is_module_request(&self) -> bool

Returns true if this data is a ModuleRequest.

pub fn is_name(&self) -> bool

Returns true if this data is a Name.

pub fn is_number(&self) -> bool

Returns true if this data is a Number.

pub fn is_object_template(&self) -> bool

Returns true if this data is a ObjectTemplate.

pub fn is_primitive(&self) -> bool

Returns true if this data is a Primitive.

pub fn is_private(&self) -> bool

Returns true if this data is a Private.

pub fn is_string(&self) -> bool

Returns true if this data is a String.

pub fn is_symbol(&self) -> bool

Returns true if this data is a Symbol.

pub fn is_value(&self) -> bool

Returns true if this data is a Value.

Trait Implementations

impl Debug for Module

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

Formats the value using the given formatter.

impl Deref for Module

type Target = Data

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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<'s> PartialEq<Data> for Module

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'s> PartialEq<Module> for Data

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'s> PartialEq for Module

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Module