Struct perseus::plugins::ControlPluginAction

pub struct ControlPluginAction<A, R> { /* private fields */ }

A control action, which can only be taken by one plugin. When run, control actions will return an Option<R> on what their runners return, which will be None if no runner is set.

Trait Implementations

impl<A, R> Debug for ControlPluginAction<A, R>

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

Formats the value using the given formatter.

impl<A, R> Default for ControlPluginAction<A, R>

fn default() -> Self

Returns the “default value” for a type.

impl<A, R> PluginAction<A, R, Option<R>> for ControlPluginAction<A, R>

fn run(
    &self,
    action_data: A,
    plugin_data: &HashMap<String, Box<dyn Any + Send>>
) -> Option<R>

Runs the single registered runner for the action.

fn register_plugin(
    &mut self,
    name: &str,
    runner: impl Fn(&A, &(dyn Any + Send)) -> R + Send + 'static
)

Registers a plugin that takes this action.

fn register_plugin_box(&mut self, name: &str, runner: Runner<A, R>)

Same as .register_plugin(), but takes a prepared runner in a Box.