Struct SubcommandRunner

pub struct SubcommandRunner { /* private fields */ }

A struct that manages loading and running subcommand plugins

Implementations

impl SubcommandRunner

pub fn new() -> Result<Self>

Creates a new subcommand runner with no plugins loaded.

pub async fn new_with_plugins( plugins: impl IntoIterator<Item = impl AsRef<Path>>, ) -> Result<Self>

Create a new runner initialized with the list of plugins provided.

This function will fail if any of the plugins fail to load. If you want to gracefully handle errors, use add_plugin instead.

pub async fn add_plugin(&mut self, path: impl AsRef<Path>) -> Result<Metadata>

Adds a plugin to the runner, returning the metadata for the plugin and otherwise returning an error if there was a problem loading the plugin. This can happen due to bad instantiation or if a plugin with the same ID has already been loaded. As such, errors from this function should be treated as a warning as execution can continue

pub async fn update_plugin( &mut self, path: impl AsRef<Path>, ) -> Result<Metadata>

Same as add_plugin, but will not return an error if the plugin exists, instead updating the metadata for the plugin. This is an upsert operation and will register the plugin if it does not exist.

pub fn metadata(&self, id: &str) -> Option<&Metadata>

Get the metadata for a plugin with the given ID if it exists.

pub fn all_metadata(&self) -> Vec<&Metadata>

Returns a list of all metadata for all plugins.

pub fn path(&self, id: &str) -> Option<&Path>

Returns the path to the plugin with the given ID.

pub async fn run( &mut self, plugin_id: &str, plugin_dir: PathBuf, dirs: Vec<DirMapping>, args: Vec<String>, ) -> Result<()>

Run a subcommand with the given name and args. The plugin will inherit all stdout/stderr/stdin/env. The given plugin_dirs will be mapped into the plugin after canonicalizing all paths and normalizing them to use / instead of \. An error will only be returned if there was a problem with the plugin (such as the plugin dirs not existing or failure to canonicalize) or the subcommand itself.

All plugins will be passed environment variables starting with WASH_PLUGIN_${plugin_id.to_upper()}_ from the current process. Other vars will be ignored