Trait Module 

pub trait Module:
    Asset
    + Send
    + Sync
    + NonLocalValue
    + ValueDebug {
    // Required method
    fn ident(self: Vc<Self>) -> Vc<AssetIdent>
       where Self: Sized;

    // Provided methods
    fn ident_string(self: Vc<Self>) -> Vc<RcStr>
       where Self: Sized { ... }
    fn references(self: Vc<Self>) -> Vc<ModuleReferences>
       where Self: Sized { ... }
    fn is_self_async(self: Vc<Self>) -> Vc<bool>
       where Self: Sized { ... }
    fn is_marked_as_side_effect_free(
        self: Vc<Self>,
        _side_effect_free_packages: Vc<Glob>,
    ) -> Vc<bool>
       where Self: Sized { ... }
}

A module. This usually represents parsed source code, which has references to other modules.

Required Methods

fn ident(self: Vc<Self>) -> Vc<AssetIdent>

where Self: Sized,

The identifier of the Module. It’s expected to be unique and capture all properties of the Module.

Provided Methods

fn ident_string(self: Vc<Self>) -> Vc<RcStr>

where Self: Sized,

The identifier of the Module as string. It’s expected to be unique and capture all properties of the Module.

fn references(self: Vc<Self>) -> Vc<ModuleReferences>

where Self: Sized,

Other Modules or [OutputAsset]s referenced from this Module.

fn is_self_async(self: Vc<Self>) -> Vc<bool>

where Self: Sized,

Signifies the module itself is async, e.g. it uses top-level await, is a wasm module, etc.

fn is_marked_as_side_effect_free( self: Vc<Self>, _side_effect_free_packages: Vc<Glob>, ) -> Vc<bool>

where Self: Sized,

Returns true if the module is marked as side effect free in package.json or by other means.

Trait Implementations

impl VcValueTrait for Box<dyn Module>

type ValueTrait = dyn Module

fn get_trait_type_id() -> TraitTypeId

Returns the type id of the trait object.

fn get_impl_vtables() -> &'static VTableRegistry<Self::ValueTrait>

Returns the vtable for an implementation of this trait. Panics if ValueTypeId does not implement the trait.

impl Dynamic<Box<dyn Asset>> for Box<dyn Module>

impl Dynamic<Box<dyn Module>> for Box<dyn Module>

impl Dynamic<Box<dyn ValueDebug>> for Box<dyn Module>

impl Upcast<Box<dyn Asset>> for Box<dyn Module>

impl Upcast<Box<dyn Module>> for Box<dyn Module>

impl Upcast<Box<dyn ValueDebug>> for Box<dyn Module>

impl UpcastStrict<Box<dyn Asset>> for Box<dyn Module>

impl UpcastStrict<Box<dyn ValueDebug>> for Box<dyn Module>

Implementors

impl Module for NodeAddonModule

impl Module for RawModule

impl<T> Module for T

where T: Dynamic<Box<dyn Module>> + Asset + Send + Sync + NonLocalValue + ValueDebug,