Struct ModuleWrapper 

pub struct ModuleWrapper { /* private fields */ }

A wrapper type representing a runtime instance loaded with a single module

Exactly equivalent to Runtime::new followed by Runtime::load_module

Can also be created using the crate::import function

Implementations

impl ModuleWrapper

pub fn new_from_module( module: &Module, options: RuntimeOptions, ) -> Result<Self, Error>

Creates a new ModuleWrapper from a given module and runtime options.

Arguments

• module - A reference to the module to load.
• options - The runtime options for the module.

Returns

A Result containing Self on success or an Error on failure.

Errors

Will return an error if module execution fails

pub fn new_from_file(path: &str, options: RuntimeOptions) -> Result<Self, Error>

Creates a new ModuleWrapper from a file path and runtime options.

Arguments

• path - The path to the module file.
• options - The runtime options for the module.

Returns

A Result containing Self on success or an Error on failure.

Errors

Will return an error if the file cannot be loaded, or if module execution fails

pub fn get_module_context(&self) -> &ModuleHandle

Returns a reference to the module context.

pub fn get_runtime(&mut self) -> &mut Runtime

Returns a mutable reference to the underlying runtime.

pub fn get<T>(&mut self, name: &str) -> Result<T, Error>

where T: DeserializeOwned,

Retrieves a value from the module by name and deserializes it.

See Runtime::get_value

Arguments

• name - The name of the value to retrieve.

Returns

A Result containing the deserialized value of type T on success or an Error on failure.

Errors

Will return an error if the value cannot be found, or deserialized into the given type

pub async fn get_async<T>(&mut self, name: &str) -> Result<T, Error>

where T: DeserializeOwned,

Retrieves a future resolving to a value from the module by name and deserializes it.

See Runtime::get_value_async

Arguments

• name - The name of the value to retrieve.

Returns

A Result containing the deserialized value of type T on success or an Error on failure.

Errors

Will return an error if the value cannot be found, or deserialized into the given type

pub fn get_immediate<T>(&mut self, name: &str) -> Result<T, Error>

where T: DeserializeOwned,

Retrieves a value from the module by name and deserializes it.

Does not await promises or the event loop.

See Runtime::get_value_immediate

Arguments

• name - The name of the value to retrieve.

Returns

A Result containing the deserialized value of type T on success or an Error on failure.

Errors

Will return an error if the value cannot be found, or deserialized into the given type

pub fn is_callable(&mut self, name: &str) -> bool

Checks if a value in the module with the given name is callable as a JavaScript function.

Arguments

• name - The name of the value to check for callability.

Returns

true if the value is callable as a JavaScript function, false otherwise.

pub fn call<T>(&mut self, name: &str, args: &impl Serialize) -> Result<T, Error>

where T: DeserializeOwned,

Calls a function in the module with the given name and arguments and deserializes the result.

See Runtime::call_function

Arguments

• name - The name of the function to call.
• args - The arguments to pass to the function.

Returns

A Result containing the deserialized result of type T on success or an Error on failure.

Errors

Will return an error if the function cannot be called, if the function returns an error, or if the function returns a value that cannot be deserialized into the given type

pub async fn call_async( &mut self, name: &str, args: &impl Serialize, ) -> Result<Value, Error>

Calls a function in the module with the given name and arguments and deserializes the result.

See Runtime::call_function_async

Arguments

• name - The name of the function to call.
• args - The arguments to pass to the function.

Returns

A Result containing the deserialized result of type T on success or an Error on failure.

Errors

Will return an error if the function cannot be called, if the function returns an error, or if the function returns a value that cannot be deserialized into the given type

pub fn call_immediate( &mut self, name: &str, args: &impl Serialize, ) -> Result<Value, Error>

Calls a function in the module with the given name and arguments and deserializes the result.
Does not await promises or the event loop.

See Runtime::call_function_immediate

Arguments

• name - The name of the function to call.
• args - The arguments to pass to the function.

Returns

A Result containing the deserialized result of type T on success or an Error on failure.

Errors

Will return an error if the function cannot be called, if the function returns an error, or if the function returns a value that cannot be deserialized into the given type

pub fn call_stored<T>( &mut self, function: &Function, args: &impl Serialize, ) -> Result<T, Error>

where T: DeserializeOwned,

Calls a function using the module’s runtime that was previously stored as a Function object

See Runtime::call_stored_function

Arguments

• function - The Function to call.
• args - The arguments to pass to the function.

Returns

A Result containing the deserialized result of type T on success or an Error on failure.

Errors

Will return an error if the function cannot be called, if the function returns an error, or if the function returns a value that cannot be deserialized into the given type

pub async fn call_stored_async( &mut self, function: &Function, args: &impl Serialize, ) -> Result<Value, Error>

Calls a function using the module’s runtime that was previously stored as a Function object

See Runtime::call_stored_function_async

Arguments

• function - The Function to call.
• args - The arguments to pass to the function.

Returns

A Result containing the deserialized result of type T on success or an Error on failure.

Errors

Will return an error if the function cannot be called, if the function returns an error, or if the function returns a value that cannot be deserialized into the given type

pub fn call_stored_immediate( &mut self, function: &Function, args: &impl Serialize, ) -> Result<Value, Error>

Calls a function using the module’s runtime that was previously stored as a Function object

Does not await promises or the event loop.

See Runtime::call_stored_function_immediate

Arguments

• function - The Function to call.
• args - The arguments to pass to the function.

Returns

A Result containing the deserialized result of type T on success or an Error on failure.

Errors

Will return an error if the function cannot be called, if the function returns an error, or if the function returns a value that cannot be deserialized into the given type

pub fn keys(&mut self) -> Vec<String>

Retrieves the names of the module’s exports.
(Keys that are not valid UTF-8, may not work as intended due to encoding issues)

Returns

A Vec of String containing the names of the keys.