Struct memflow::plugins::PluginDescriptor

#[repr(C)]
pub struct PluginDescriptor<T: Loadable> {
    pub plugin_version: i32,
    pub accept_input: bool,
    pub input_layout: &'static TypeLayout,
    pub output_layout: &'static TypeLayout,
    pub name: CSliceRef<'static, u8>,
    pub version: CSliceRef<'static, u8>,
    pub description: CSliceRef<'static, u8>,
    pub help_callback: Option<extern "C" fn(callback: HelpCallback<'_>)>,
    pub target_list_callback: Option<extern "C" fn(callback: TargetCallback<'_>) -> i32>,
    pub create: CreateFn<T>,
}

Fields

plugin_version: i32

The plugin api version for when the plugin was built. This has to be set to MEMFLOW_PLUGIN_VERSION of memflow.

If the versions mismatch the inventory will refuse to load.

accept_input: bool

Does the plugin accept an input parameter?

input_layout: &'static TypeLayout

Layout of the input type.

output_layout: &'static TypeLayout

Layout of the loaded type.

name: CSliceRef<'static, u8>

The name of the plugin. This name will be used when loading a plugin from the inventory.

During plugin discovery, the export suffix has to match this name being capitalized

version: CSliceRef<'static, u8>

The version of the connector. If multiple connectors are installed the latest is picked.

description: CSliceRef<'static, u8>

The description of the connector.

help_callback: Option<extern "C" fn(callback: HelpCallback<'_>)>

Retrieves a help string from the plugin (lists all available commands)

target_list_callback: Option<extern "C" fn(callback: TargetCallback<'_>) -> i32>

Retrieves a list of available targets for the plugin

create: CreateFn<T>

Create instance of the plugin