Struct PluginRegistry

pub struct PluginRegistry { /* private fields */ }

Implementations

impl PluginRegistry

pub fn new() -> Self

pub fn num_plugins(&self) -> usize

Return the count of different plugins

A plugin can be registered for several layers, but it will count as one.

pub fn add_plugin(&mut self, plugin: SafePlugin) -> PluginID

Add a plugin to the registry, and return the identifier

pub fn run_plugins<F, P>(&self, predicate: P, f: F)

where F: FnMut(&mut dyn Plugin), P: FnMut(&dyn Plugin) -> bool,

Run function F on all known plugins (registered or not) matching P

pub fn register_layer( &mut self, layer: u8, layer_filter: u16, plugin_id: PluginID, ) -> Result<(), PluginBuilderError>

Register a layer for analysis, for the identified plugin

layer_filter is a filter on the value relative to the layer: for L3, use for ex. ETHERNET_IPV4, for L4, TRANSPORT_TCP, etc. Special value 0 for layer_filter means all possible values.

pub fn get_plugins_for_layer( &self, layer: u8, layer_filter: u16, ) -> Option<&Vec<SafePlugin>>

Get plugins matching the given layer and layer_filter

pub fn iter_registered_plugins( &self, ) -> impl Iterator<Item = (&PluginInfo, &SafePlugin)>

Return an iterator on registered plugins

The same plugin instance can be present multiple times, if registered with different PluginInfo (for ex. layer filters).

pub fn iter_plugins(&self) -> impl Iterator<Item = &SafePlugin>

Return an iterator on all known plugins

Known plugins are plugins present in the registry (registered or not for layers)

Trait Implementations

impl Default for PluginRegistry

fn default() -> PluginRegistry

Returns the “default value” for a type.