Struct Plugin

pub struct Plugin<'a> { /* private fields */ }

Plugin interface.

Methods are loaded using libloading. If required methods aren’t found, the plugin isn’t loaded. All optional methods are checked first, before being executed.

Using this interface is reasonably safe.

Implementations

impl<'a> Plugin<'a>

pub fn library<P: AsRef<Path>>(name: P) -> Result<Library, Error>

Load plugin’s shared library using a cross-platform naming convention.

Plugin has to be in LD_LIBRARY_PATH, in a standard location for the operating system, or be provided as an absolute or relative path, including the platform-specific extension.

Example

use pgdog_plugin::Plugin;

let plugin_lib = Plugin::library("/home/pgdog/plugin.so").unwrap();
let plugin_lib = Plugin::library("plugin.so").unwrap();

pub fn load(name: &str, library: &'a Library) -> Self

Load standard plugin methods from the plugin library.

Arguments

• name: Plugin name. Can be any name you want, it’s only used for logging.
• library: libloading::Library reference. Must have the same, ideally static, lifetime as the plugin.

pub fn init(&self) -> bool

Execute plugin’s initialization routine. Returns true if the route exists and was executed, false otherwise.

pub fn fini(&self)

Execute plugin’s shutdown routine.

pub fn route(&self, context: PdRouterContext) -> Option<PdRoute>

Execute plugin’s route routine. Determines where a statement should be sent. Returns a route if the routine is defined, or None if not.

Arguments

• context: Statement context created by PgDog’s query router.

pub fn name(&self) -> &str

Returns plugin’s name. This is the same name as what is passed to Plugin::load function.

pub fn rustc_version(&self) -> Option<PdStr>

Returns the Rust compiler version used to build the plugin. This version must match the compiler version used to build PgDog, or the plugin won’t be loaded.

pub fn version(&self) -> Option<PdStr>

Get plugin version. It’s set in plugin’s Cargo.toml.

Trait Implementations

impl<'a> Debug for Plugin<'a>

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

Formats the value using the given formatter.