Struct dygpi::manager::PluginManager

pub struct PluginManager<T> where
    T: Plugin,  { /* fields omitted */ }

The plugin manager loads and unloads plugins from a library which is dynamically opened and closed as necessary.

Implementations

impl<T> PluginManager<T> where
    T: Plugin, 

pub fn new_with_search_path(search_path: SearchPath) -> Self

Construct a new plugin manager and have it use the values of the string slice as a search path when loading libraries.

pub fn load_all_plugins_from_env(&mut self, env_var: &str) -> Result<()>

Load all plugins from the libraries that are specified in the named environment variable.

The environment variable’s value is assumed to be a list of paths separated by the colon, ':' character.

pub fn load_plugins_from_all(&mut self, file_names: &[&Path]) -> Result<()>

Load all plugins from the libraries specified in the string slice, each value is a file path.

pub fn load_plugins_from(&mut self, file_name: &Path) -> Result<()>

Load all plugins from a single library with the provided file name/path.

pub fn set_registration_fn_name(&mut self, name: &[u8])

Override the default registration function name PLUGIN_REGISTRATION_FN_NAME.

This function must conform to the type PluginRegistrationFn, and must be marked as #[no_mangle] pub extern "C" in the same manner as the standard registration function.

Example

use dygpi::plugin::{Plugin, PluginRegistrar};

#[no_mangle]
pub extern "C" fn register_sources(registrar: &mut PluginRegistrar<SoundSourcePlugin>) {
    registrar.register(SoundSourcePlugin::new(PLUGIN_NAME));
}

#[no_mangle]
pub extern "C" fn register_effects(registrar: &mut PluginRegistrar<SoundEffectPlugin>) {
    registrar.register(SoundEffectPlugin::new(OTHER_PLUGIN_NAME));
}

pub fn is_empty(&self) -> bool

Returns true if the plugin manager has no plugins registered, else false.

pub fn len(&self) -> usize

Return the number of plugins registered in this plugin manager.

pub fn contains(&self, plugin_id: &str) -> bool

Returns true if this plugin manager has a registered plugin with the provided plugin identifier, else false.

pub fn get(&self, plugin_id: &str) -> Option<Arc<T>>

Returns the plugin with the provided plugin identifier, if one exists, else None.

pub fn plugins(&self) -> Vec<Arc<T>>

Return all the plugins registered in this plugin manager as a vector.

pub fn unload_all(&mut self) -> Result<()>

Unload all plugins, and associated libraries, that are currently registered in this plugin manager.

pub fn unload_plugin(&mut self, plugin_name: &str) -> Result<()>

Unload the plugin identified by the provided plugin identifier, if one exists. Note that this method will also close the plugin library if no other plugins are using it.

Trait Implementations

impl<T: Debug> Debug for PluginManager<T> where
    T: Plugin, 

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

Formats the value using the given formatter.

impl<T> Default for PluginManager<T> where
    T: Plugin, 

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for PluginManager<T> where
    T: Plugin, 

fn drop(&mut self)

Executes the destructor for this type.