Struct StandardPlugin

pub struct StandardPlugin { /* private fields */ }

Standard plugin implementation for single-tool plugins

This is a convenience implementation for plugins that provide a single tool. It handles the boilerplate of implementing VxPlugin for simple cases.

Implementations

impl StandardPlugin

pub fn new<F>( name: impl Into<String>, description: impl Into<String>, version: impl Into<String>, tool_factory: F, ) -> Self

where F: Fn() -> Box<dyn VxTool> + Send + Sync + 'static,

Create a new standard plugin

Arguments

• name - Plugin name
• description - Plugin description
• version - Plugin version
• tool_factory - Factory function that creates the tool instance

pub fn with_author(self, author: impl Into<String>) -> Self

Set the plugin author

pub fn with_homepage(self, homepage: impl Into<String>) -> Self

Set the plugin homepage

Trait Implementations

impl VxPlugin for StandardPlugin

fn name(&self) -> &str

Plugin name (required)

fn description(&self) -> &str

Plugin description (optional)

fn version(&self) -> &str

Plugin version (optional)

fn author(&self) -> Option<&str>

Plugin author (optional)

fn homepage(&self) -> Option<&str>

Plugin homepage or repository URL (optional)

fn tools(&self) -> Vec<Box<dyn VxTool>>

Get all tools provided by this plugin

fn package_managers(&self) -> Vec<Box<dyn VxPackageManager>>

Get all package managers provided by this plugin

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

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

Initialize the plugin (optional)

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

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

Shutdown the plugin (optional)

fn supports_tool(&self, tool_name: &str) -> bool

Check if this plugin supports a specific tool

fn supports_package_manager(&self, pm_name: &str) -> bool

Check if this plugin supports a specific package manager

fn get_tool(&self, tool_name: &str) -> Option<Box<dyn VxTool>>

Get a specific tool by name

fn get_package_manager( &self, pm_name: &str, ) -> Option<Box<dyn VxPackageManager>>

Get a specific package manager by name

fn is_compatible_with(&self, vx_version: &str) -> bool

Check plugin compatibility with the current vx version

fn dependencies(&self) -> Vec<&str>

Get plugin dependencies

fn config_schema(&self) -> Option<Value>

Get plugin configuration schema

fn validate_config(&self, _config: &Value) -> Result<()>

Validate plugin configuration

fn metadata(&self) -> HashMap<String, String>

Additional metadata for the plugin (optional)