Struct PluginContainerManagerImpl

pub struct PluginContainerManagerImpl {
    pub plugin_containers: DashMap<Uuid, PluginContainer>,
}

Fields

plugin_containers: DashMap<Uuid, PluginContainer>

The plugin containers.

Trait Implementations

impl Component for PluginContainerManagerImpl

fn create( instance_provider: &mut dyn ComponentInstanceProvider, ) -> Result<Self, ComponentInstanceProviderError>

Creates an instance of this component using dependencies from given [ComponentInstanceProvider].

impl ComponentDowncast<PluginContainerManagerImpl> for PluginContainerManagerImpl

fn downcast( source: ComponentInstanceAnyPtr, ) -> Result<ComponentInstancePtr<Self>, ComponentInstanceAnyPtr>

impl ComponentDowncast<PluginContainerManagerImpl> for dyn PluginContainerManager + Sync + Send

fn downcast( source: ComponentInstanceAnyPtr, ) -> Result<ComponentInstancePtr<Self>, ComponentInstanceAnyPtr>

impl Lifecycle for PluginContainerManagerImpl

fn init<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Called at initialization

fn post_init<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Called after initialization

fn pre_shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Called before shutdown

fn shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Called for shutdown

impl PluginContainerManager for PluginContainerManagerImpl

fn create_and_register_plugin_container( &self, stem: String, path: PathBuf, ) -> Option<Uuid>

Creates a new plugin container for a plugin with the given file stem. The dynamically linked library is located at the given path which have to be in the plugin installation folder.

fn remove_plugin_container(&self, id: &Uuid)

Returns the plugin with the given id from the list of plugin containers.

fn has(&self, stem: &str) -> bool

Returns true, if a plugin with the given file stem exists.

fn get_id(&self, stem: &str) -> Option<Uuid>

Returns the id of the plugin with the given file stem.

fn get_stem(&self, id: &Uuid) -> Option<String>

Returns the file stem of the plugin with the given id.

fn name(&self, id: &Uuid) -> Option<String>

Returns the name of the plugin with the given id.

fn name_canonicalized(&self, id: &Uuid) -> Option<String>

Returns the canonicalized name of the plugin with the given id.

fn name_version(&self, id: &Uuid) -> Option<String>

Returns the canonicalized name and version of the plugin with the given id.

fn description(&self, id: &Uuid) -> Option<String>

Returns the description of the plugin with the given id.

fn version(&self, id: &Uuid) -> Option<String>

Returns the version of the plugin with the given id.

fn rustc_version(&self, id: &Uuid) -> Option<String>

Returns the version of the rust compiler the plugin with the given id was compiled with.

fn plugin_api_version(&self, id: &Uuid) -> Option<String>

Returns the version of the plugin API the plugin with the given id was compiled with.

fn count(&self) -> usize

Returns the count of all plugins.

fn count_by_state(&self, state: &PluginState) -> usize

Returns the count of plugins with the given state.

fn count_by_states(&self) -> String

Returns a string withs stats abouts the states of the plugins

fn count_by_state_str(&self, state: &PluginState) -> String

fn get_plugin_path(&self, id: &Uuid) -> Option<String>

Returns the path of the plugin with the given id.

fn get_plugin_state(&self, id: &Uuid) -> Option<PluginState>

Returns the state of the plugin with the given id.

fn get_plugins(&self) -> Vec<Uuid>

Returns a list of ids of all plugins.

fn get_plugins_with_state(&self, state: PluginState) -> Vec<Uuid>

Returns a list of ids of plugins with the given state.

fn get_plugins_with_states( &self, state1: PluginState, state2: PluginState, ) -> Vec<Uuid>

Returns a list of ids of plugins which have one of the both states.

fn get_plugins_not_having_state(&self, state: PluginState) -> Vec<Uuid>

Returns a list of ids of plugins which doesn’t have the given state.

fn get_plugin_by_dependency( &self, plugin_dependency: &PluginDependency, ) -> Option<Uuid>

Returns the id of the plugin by a dependency coordinate.

fn deploy_dll(&self, id: &Uuid) -> PluginTransitionResult

Deploys the dynamic linked library file from the plugin hot deploy folder into the plugin installation folder.

fn load_dll(&self, id: &Uuid) -> PluginTransitionResult

Loads the dynamic linked library into memory.

fn load_plugin_declaration(&self, id: &Uuid) -> PluginTransitionResult

Loads the plugin declaration of the plugin with the given id.

fn check_plugin_compatibility(&self, id: &Uuid) -> PluginTransitionResult

Performs a compatibility check on the plugin with the given id.

fn load_plugin_dependencies(&self, id: &Uuid) -> PluginTransitionResult

Loads the dependencies of the plugin with the given id.

fn get_dependency_state(&self, dependency: &PluginDependency) -> PluginState

Returns the state of the plugin with the given dependency coordinate.

fn has_dependencies(&self, id: &Uuid) -> bool

Returns true, if the plugin with the given id has one or multiple dependencies.

fn get_dependencies(&self, id: &Uuid) -> DashSet<PluginDependency>

Returns a list of dependency coordinates for the plugin with the given id.

fn has_unsatisfied_dependencies(&self, id: &Uuid) -> bool

Returns true, if the plugin with the given id has unsatisfied dependencies.

fn get_unsatisfied_dependencies(&self, id: &Uuid) -> DashSet<PluginDependency>

Returns a list of unsatisfied dependencies of the plugin with the given id.

fn get_dependents(&self, id: &Uuid) -> Vec<Uuid>

Returns a list of plugin ids which are dependents of the plugin with the given id.

fn set_state(&self, id: &Uuid, new_state: PluginState) -> PluginTransitionResult

Sets the given new state of the plugin with the given id.

fn resolve_dependencies_state( &self, id: &Uuid, refreshing: bool, ) -> PluginTransitionResult

Calculates the state of the dependencies of the plugin with the given id.

fn construct_proxy( &self, id: &Uuid, plugin_context: Arc<dyn PluginContext + Send + Sync>, ) -> PluginTransitionResult

Constructs a plugin proxy object for the plugin with the given id.

fn register(&self, id: &Uuid) -> PluginTransitionResult

Registers providers of the plugin with the given id.

fn activate<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 Uuid, ) -> Pin<Box<dyn Future<Output = PluginTransitionResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Calls the activate method of the plugin with the given id.

fn are_all_stopped(&self) -> bool

Returns true, if all plugins are stopped.

fn deactivate<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 Uuid, ) -> Pin<Box<dyn Future<Output = PluginTransitionResult> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Calls the deactivate method of the plugin with the given id.

fn unregister(&self, id: &Uuid) -> PluginTransitionResult

Unregisters the providers of the plugin with the given id.

fn remove_proxy(&self, id: &Uuid) -> PluginTransitionResult

Removes the plugin proxy of the plugin with the given id.

fn unload_dll(&self, id: &Uuid) -> PluginTransitionResult

Closes the library by dropping it.

fn uninstall_dll(&self, id: &Uuid) -> PluginTransitionResult

Deletes the dynamically linked library file.

fn start(&self, id: &Uuid) -> Result<(), PluginStartError>

Start the plugin with the given id.

fn start_by_stem(&self, stem: &str) -> Result<(), PluginStartError>

Starts the plugin with the given file stem.

fn start_dependent_with_satisfied_dependencies(&self, id: &Uuid) -> bool

Starts all plugins which are dependent of the plugin with the given id and have no unsatisfied dependencies.

fn stop(&self, id: &Uuid) -> Result<(), PluginStopError>

Stops the given plugin. Recursively stops all plugins which depends on the stopped plugin.

fn stop_by_stem(&self, stem: &str) -> Result<(), PluginStopError>

Stops the plugin with the given file stem.

fn stop_all(&self)

Stops all plugins.

fn stop_active_with_unsatisfied_dependencies(&self) -> bool

Stops active plugins which have unsatisfied dependencies.

fn uninstall(&self, id: &Uuid) -> Result<(), PluginUninstallError>

Uninstalls the plugin with the given id.

fn redeploy(&self, id: &Uuid) -> Result<(), PluginDeployError>

Redeploys the plugin with the given id.

fn disable(&self, id: &Uuid) -> Result<(), PluginDisableError>

Disables the plugin with the given id.

impl Injectable for PluginContainerManagerImpl