Struct rquickjs_core::Module

pub struct Module<'js, S = Evaluated>(_, _);

Javascript module with certain exports and imports

Implementations

impl<'js> Module<'js>

pub fn name<N>(&self) -> Result<N> where
    N: FromAtom<'js>, 

Returns the name of the module

pub fn meta<T>(&self) -> Result<T> where
    T: FromJs<'js>, 

Return the import.meta object of a module

impl<'js> Module<'js>

pub fn new<N, S>(
    ctx: Ctx<'js>,
    name: N,
    source: S
) -> Result<Module<'js, Loaded<Script>>> where
    N: Into<Vec<u8>>,
    S: Into<Vec<u8>>, 

Create module from JS source

pub fn new_def<D, N>(
    ctx: Ctx<'js>,
    name: N
) -> Result<Module<'js, Loaded<Native>>> where
    D: ModuleDef,
    N: Into<Vec<u8>>, 

Create native JS module using ModuleDef

pub unsafe fn new_raw<N>(
    ctx: Ctx<'js>,
    name: N,
    load: ModuleLoadFn
) -> Result<Module<'js, Loaded<Native>>> where
    N: Into<Vec<u8>>, 

Create native JS module by calling init function (like js_module_init)

Safety

The load function should not crash. But it can throw exception and return null pointer in that case.

pub unsafe extern "C" fn init_raw<D>(
    ctx: *mut JSContext,
    name: *const c_char
) -> *mut JSModuleDef where
    D: ModuleDef, 

The function for loading native JS module

Safety

This function should only be called from js_module_init function.

impl<'js> Module<'js, Loaded<Script>>

pub fn read_object<B: AsRef<[u8]>>(ctx: Ctx<'js>, buf: B) -> Result<Self>

Load module from bytecode

pub fn read_object_const(ctx: Ctx<'js>, buf: &'static [u8]) -> Result<Self>

Load module from bytecode (static const)

pub fn write_object(&self, byte_swap: bool) -> Result<Vec<u8>>

Write bytecode of loaded module

impl<'js> Module<'js, Loaded<Native>>

pub fn set<N, T>(&self, name: N, value: T) -> Result<()> where
    N: AsRef<str>,
    T: IntoJs<'js>, 

Set exported entry by name

NOTE: Exported entries should be added before module instantiating using Module::add.

impl<'js, S> Module<'js, Loaded<S>>

pub fn eval(self) -> Result<Module<'js, Evaluated>>

Evaluate a loaded module

To get access to module exports it should be evaluated first, in particular when you create module manually via Module::new.

pub fn into_loaded(self) -> Module<'js, Loaded>

Cast the specific loaded module to generic one

impl<'js> Module<'js, Created>

pub fn add<N>(&self, name: N) -> Result<()> where
    N: AsRef<str>, 

Add entry to module exports

NOTE: Added entries should be set after module instantiating using Module::set.

impl<'js> Module<'js>

pub fn get<N, T>(&self, name: N) -> Result<T> where
    N: AsRef<str>,
    T: FromJs<'js>, 

Return exported value by name

pub fn names<N>(&self) -> ExportNamesIter<'js, N> where
    N: FromAtom<'js>, 

Available on crate feature exports only.

Returns a iterator over the exported names of the module export.

pub fn entries<N, T>(&self) -> ExportEntriesIter<'js, N, T> where
    N: FromAtom<'js>,
    T: FromJs<'js>, 

Available on crate feature exports only.

Returns a iterator over the items the module export.

impl<'js> Module<'js, Evaluated>

pub fn as_value(&self) -> &Value<'js>

Reference to value

pub fn into_value(self) -> Value<'js>

Convert into value

pub fn from_value(value: Value<'js>) -> Result<Self>

Convert from value

Methods from Deref<Target = Value<'js>>

pub fn as_bool(&self) -> Option<bool>

Try get bool from value

pub fn as_int(&self) -> Option<i32>

Try get int from value

pub fn as_float(&self) -> Option<f64>

Try get float from value

pub fn as_number(&self) -> Option<f64>

Try get any number from value

pub fn is_bool(&self) -> bool

Check if the value is a bool

pub fn is_int(&self) -> bool

Check if the value is an int

pub fn is_float(&self) -> bool

Check if the value is a float

pub fn is_number(&self) -> bool

Check if the value is an any number

pub fn is_string(&self) -> bool

Check if the value is a string

pub fn is_symbol(&self) -> bool

Check if the value is a symbol

pub fn is_object(&self) -> bool

Check if the value is an object

pub fn is_module(&self) -> bool

Check if the value is a module

pub fn is_array(&self) -> bool

Check if the value is an array

pub fn is_function(&self) -> bool

Check if the value is a function

pub fn is_error(&self) -> bool

Check if the value is an error

pub fn as_value(&self) -> &Self

Reference as value

pub fn get<T: FromJs<'js>>(&self) -> Result<T>

Convert from value to specified type

pub fn type_of(&self) -> Type

Get the type of value

pub fn type_name(&self) -> &'static str

Get the name of type

pub unsafe fn ref_string(&self) -> &String<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_string(&self) -> Option<&String<'js>>

Try reinterprete as

pub unsafe fn ref_symbol(&self) -> &Symbol<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_symbol(&self) -> Option<&Symbol<'js>>

Try reinterprete as

pub unsafe fn ref_object(&self) -> &Object<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_object(&self) -> Option<&Object<'js>>

Try reinterprete as

pub unsafe fn ref_array(&self) -> &Array<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_array(&self) -> Option<&Array<'js>>

Try reinterprete as

pub unsafe fn ref_function(&self) -> &Function<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_function(&self) -> Option<&Function<'js>>

Try reinterprete as

pub unsafe fn ref_module(&self) -> &Module<'js, Evaluated>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_module(&self) -> Option<&Module<'js, Evaluated>>

Try reinterprete as

Trait Implementations

impl<'js> AsRef<Value<'js>> for Module<'js, Evaluated>

fn as_ref(&self) -> &Value<'js>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'js, S> Clone for Module<'js, S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js, S: Debug> Debug for Module<'js, S>

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

Formats the value using the given formatter.

impl<'js> Deref for Module<'js, Evaluated>

type Target = Value<'js>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'js> From<Module<'js, Evaluated>> for Value<'js>

fn from(value: Module<'js, Evaluated>) -> Self

Converts to this type from the input type.

impl<'js> FromJs<'js> for Module<'js, Evaluated>

fn from_js(_: Ctx<'js>, value: Value<'js>) -> Result<Self>

impl<'js> IntoAtom<'js> for Module<'js, Evaluated>

fn into_atom(self, ctx: Ctx<'js>) -> Atom<'js>

impl<'js> IntoJs<'js> for Module<'js, Evaluated>

fn into_js(self, _: Ctx<'js>) -> Result<Value<'js>>

impl<'js, S: PartialEq> PartialEq<Module<'js, S>> for Module<'js, S>

fn eq(&self, other: &Module<'js, S>) -> 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<'js, S> StructuralPartialEq for Module<'js, S>