Skip to main content

PluginRunningInstance

Struct PluginRunningInstance 

pub struct PluginRunningInstance<T: GCPluginCallbackHandler> {
    _plugin_interface: Box<GCPluginInterface>,
    plugin_dll: PluginDLL,
    startup_info: PluginInstanceStartupConfig<T>,
    plugin_ctx: GCInstanceHandle,
}
Expand description

Responsible for holding plugin data in memory for the duration of the plugin instance execution

Fields§

§_plugin_interface: Box<GCPluginInterface>§plugin_dll: PluginDLL§startup_info: PluginInstanceStartupConfig<T>§plugin_ctx: GCInstanceHandle

Implementations§

§

impl<T: GCPluginCallbackHandler> PluginRunningInstance<T>

pub fn start( startup_config: PluginInstanceStartupConfig<T>, plugin_dll: PluginDLL, ) -> Result<Self, GCPluginManagerError>

Starts the plugin instance by calling gc_plugin_init and passing the necessary data to the plugin.

pub fn publish_datapoint_value( &self, datapoint_value: GCArc<GCDatapointValue>, ) -> bool

Publishes a datapoint value to the plugin by calling gc_plugin_receive_datapoint

pub fn get_plugin_info(&self) -> GCPluginInfo

Returns the plugin info by calling gc_plugin_get_info

unsafe fn stop(&mut self)

Stops the plugin instance by calling gc_plugin_shutdown

§Safety

This must be called only once!

Trait Implementations§

§

impl<T: GCPluginCallbackHandler> Debug for PluginRunningInstance<T>

§

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

Formats the value using the given formatter. Read more
§

impl<T: GCPluginCallbackHandler> Drop for PluginRunningInstance<T>

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl<T: GCPluginCallbackHandler> Send for PluginRunningInstance<T>

§

impl<T: GCPluginCallbackHandler> Sync for PluginRunningInstance<T>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.