Struct Lock 

pub struct Lock<'a> { /* private fields */ }

Available on crate feature module only.

A structure that represents a lock to the application’s ModuleLoader.

Implementations

impl<'a> Lock<'a>

pub unsafe fn load_builtin( &mut self, name: &str, ) -> Result<impl ModuleHandle + '_>

Attempts to load the given builtin module from its name.

Arguments

• name: the name of the builtin module to load.

returns: Result<&Module, Error>

Safety

This function assumes the module to be loaded, if it exists has the correct format otherwise this function is UB.

pub unsafe fn load_self(&mut self, name: &str) -> Result<impl ModuleHandle + '_>

Attempts to load a module from the specified name which is dynamically linked in the current running software.

Arguments

• name: the name of the module to be loaded.

returns: Result<&Module, Error>

Safety

This function assumes the module to be loaded, if it exists has the correct format otherwise this function is UB.

pub unsafe fn load(&mut self, name: &str) -> Result<impl ModuleHandle + '_>

Attempts to load a module from the specified name.

This function already does check for the version of rustc and dependencies for Rust based modules to ensure maximum ABI compatibility.

This function assumes the code to be loaded is trusted and delegates this operation to the underlying OS.

Arguments

• name: the name of the module to be loaded.

returns: ()

Safety

It is assumed that the module is intended to be used with this instance of ModuleLoader; if not, this function is UB. Additionally, if some dependency used in public facing APIs for the module are not added with add_public_dependency, this is also UB.

pub fn unload(&mut self, name: &str) -> Result<()>

Attempts to unload the given module.

Arguments

• name: the name of the module to unload.

returns: ()

pub fn add_search_path(&mut self, path: impl AsRef<Path>)

Adds the given path to the path search list.

Arguments

• path: the path to include.

returns: ()

pub fn remove_search_path(&mut self, path: impl AsRef<Path>)

Removes the given path to the path search list.

Arguments

• path: the path to remove.

returns: ()

pub fn add_public_dependency<'b>( &mut self, name: &str, version: &str, features: impl IntoIterator<Item = &'b str>, )

Adds a public facing API dependency to the list of dependency for version checks.

This is used to check if there are any ABI incompatibilities between dependency versions when loading a Rust based module.

Arguments

• name: the name of the dependency.
• version: the version of the dependency.

returns: ()

pub fn get_builtin(&self, name: &str) -> Option<impl ModuleHandle + '_>

Returns the builtin module identified by the name name, returns None if the module is not loaded.

pub fn get_module(&self, name: &str) -> Option<impl ModuleHandle + '_>

Returns the module identified by the name name, returns None if the module is not loaded.