Struct tikv::coprocessor_v2::plugin_registry::LoadedPlugin

pub struct LoadedPlugin {
    name: String,
    version: Version,
    plugin: Box<dyn CoprocessorPlugin>,
}

A wrapper around a loaded raw coprocessor plugin library.

Fields

name: String

The name of the plugin.

version: Version

The version of the plugin.

plugin: Box<dyn CoprocessorPlugin>

Pointer to a CoprocessorPlugin in the loaded lib.

Implementations

impl LoadedPlugin

pub unsafe fn new<P: AsRef<OsStr>>(
    file_path: P
) -> Result<Self, PluginLoadingError>

Creates a new LoadedPlugin by loading a dylib from a file into memory.

The file_path argument may be any of:

• A simple filename of a library if the library is in any of the platform-specific locations from where libraries are usually loaded, e.g. the current directory or in LD_LIBRARY_PATH on unix systems.
• Absolute path to the library
• Relative (to the current working directory) path to the library

The function instantiates the plugin by calling _plugin_create() to obtain a CoprocessorPlugin.

Safety

The library must contain a function with name PLUGIN_CONSTRUCTOR_SYMBOL and the signature of PluginConstructorSignature. Otherwise, behavior is undefined. See also libloading::Library::get() for more information on what restrictions apply to PLUGIN_CONSTRUCTOR_SYMBOL.

pub fn name(&self) -> &str

Returns the name of the plugin.

pub fn version(&self) -> &Version

Returns the version of the plugin.

Trait Implementations

impl CoprocessorPlugin for LoadedPlugin

fn on_raw_coprocessor_request(
    &self,
    ranges: Vec<Range<Key>>,
    request: RawRequest,
    storage: &dyn RawStorage
) -> PluginResult<RawResponse>

Handles a request to the coprocessor.