Struct PluginManager

pub struct PluginManager { /* private fields */ }

Provides accesses to functionality to inspect and manage the installation of plugins.

Implementations

impl PluginManager

pub fn try_default() -> Result<Self>

Creates a PluginManager with the default install location.

pub fn store(&self) -> &PluginStore

Returns the underlying store object

pub async fn install( &self, plugin_manifest: &PluginManifest, plugin_package: &PluginPackage, source: &ManifestLocation, auth_header_value: &Option<String>, ) -> Result<String>

Installs the Spin plugin with the given manifest If installing a plugin from the centralized Spin plugins repository, it fetches the latest contents of the repository and searches for the appropriately named and versioned plugin manifest. Parses the plugin manifest to get the appropriate source for the machine OS and architecture. Verifies the checksum of the source, unpacks and installs it into the plugins directory. Returns name of plugin that was successfully installed.

pub fn uninstall(&self, plugin_name: &str) -> Result<bool>

Uninstalls a plugin with a given name, removing it and it’s manifest from the local plugins directory. Returns true if plugin was successfully uninstalled and false if plugin did not exist.

pub fn check_manifest( &self, plugin_manifest: &PluginManifest, spin_version: &str, override_compatibility_check: bool, allow_downgrades: bool, ) -> Result<InstallAction>

Checks manifest to see if the plugin is compatible with the running version of Spin, does not have a conflicting name with Spin internal commands, and is not a downgrade of a currently installed plugin.

pub async fn get_manifest( &self, manifest_location: &ManifestLocation, skip_compatibility_check: bool, spin_version: &str, auth_header_value: &Option<String>, ) -> PluginLookupResult<PluginManifest>

Fetches a manifest from a local, remote, or repository location and returned the parsed PluginManifest object.

pub async fn update_lock(&self) -> PluginManagerUpdateLock