Struct DyLibDynamicPlugin

pub struct DyLibDynamicPlugin { /* private fields */ }

Implementation of DynamicPluginTrait that (re)loads Rust code from Rust dylib .

Implementations

impl DyLibDynamicPlugin

pub fn new<P>( path: P, reload_when_changed: bool, use_relative_paths: bool, ) -> Result<Self, String>

where P: AsRef<Path> + 'static,

Tries to create a new dynamic plugin. This method attempts to load a dynamic library by the given path and searches for fyrox_plugin function. This function is called to create a plugin instance. This method will fail if there’s no dynamic library at the given path or the fyrox_plugin function is not found.

Hot reloading

This method can enable hot reloading for the plugin, by setting reload_when_changed parameter to true. When enabled, the engine will clone the library to implementation-defined path and load it. It will setup file system watcher to receive changes from the OS and reload the plugin.

Trait Implementations

impl DynamicPlugin for DyLibDynamicPlugin

fn as_loaded_ref(&self) -> &dyn Plugin

panics if not loaded

fn as_loaded_mut(&mut self) -> &mut dyn Plugin

panics if not loaded

fn is_reload_needed_now(&self) -> bool

engine polls is time to time to determine if it’s time to reload plugin

fn display_name(&self) -> String

returns human-redable short description of the plugin

fn is_loaded(&self) -> bool

returns false if something bad happends during reload. has no much use except prevention of error spamming

fn reload( &mut self, fill_and_register: &mut dyn FnMut(&mut dyn Plugin) -> Result<(), String>, ) -> Result<(), String>

called after plugin-related objects are detached fill_and_register callback exposes plugin instance to engine to register constructors and restore the state callback approach allows plugins to do some necessary actions right after plugin is registed

fn prepare_to_reload(&mut self)

called before saving state and detaching related objects