Struct PluginManager

pub struct PluginManager { /* private fields */ }

Manages loading, unloading, and interacting with Lua plugins.

This structure is responsible for:

• Loading dynamic libraries that contain Lua plugins.
• Managing plugin instances and ensuring they are correctly initialized and cleaned up.
• Automatically registering Lua functions provided by plugins.

Implementations

impl PluginManager

pub fn new() -> Self

Creates a new PluginManager.

pub fn load_plugin(&mut self, path: &str) -> Result<(), Box<dyn Error>>

Loads a plugin from a dynamic library.

Parameters

• path: Path to the dynamic library containing the plugin.

Returns

• Ok(()) if the plugin is successfully loaded.
• Err if there is an error during loading or initialization.

Safety

This method uses unsafe code to interact with the dynamic library and call the plugin’s exported create_plugin function.

pub fn unload_plugin(&mut self, name: &str) -> Result<(), Box<dyn Error>>

Unloads a plugin by its name.

Parameters

• name: Name of the plugin to be unloaded.

Returns

• Ok(()) if the plugin is successfully unloaded.
• Err if the plugin fails to clean up resources or is not found.

pub fn get_plugin(&self, name: &str) -> Option<&dyn PluginLua>

Retrieves a reference to a loaded plugin by its name.

Parameters

• name: Name of the plugin.

Returns

• Some(&dyn PluginLua) if the plugin is found.
• None if the plugin is not loaded.

pub fn register_plugin_instance( &mut self, plugin: Box<dyn PluginLua>, ) -> Result<(), Box<dyn Error>>

Registers a plugin instance directly, bypassing file loading.

Parameters

• plugin: A boxed instance of a plugin implementing the PluginLua trait.

Returns

• Ok(()) if the plugin was successfully registered.
• Err(Box<dyn Error>) if an error occurs during plugin initialization.

Example

let plugin: Box<dyn PluginLua> = Box::new(MyPlugin::new());
plugin_manager.register_plugin_instance(plugin)?;

Notes

• The plugin’s on_load method is called during this process to initialize the plugin.
• The plugin is stored in the internal plugin map for future reference.

pub fn register_all_plugins( &self, lua: &Lua, name: &str, ) -> Result<(), Box<dyn Error>>

Registers all Lua functions from all loaded plugins with the given Lua state.

Parameters

• lua: The Lua state where the functions should be registered.

Returns

• Ok(()) if all functions are registered successfully.
• Err if there is an error during registration.

Trait Implementations

impl Default for PluginManager

fn default() -> Self

Creates a default instance of PluginManager.

impl Drop for PluginManager

fn drop(&mut self)

Ensures that all plugins are unloaded and cleaned up when the PluginManager is dropped.