gc_plugin_abi 0.5.0

Gridcore Plugin API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use gc_plugin_abi::*;
#[gc_plugin]
pub struct RestSomethingPlugin {}
impl Default for RestSomethingPlugin {
    fn default() -> Self {
        Self::new()
    }
}

impl RestSomethingPlugin {
    pub fn new() -> Self {
        Self {}
    }
}

impl<'a> GCPluginInstance<'a> for RestSomethingPlugin {
    fn get_plugin_info() -> GCPluginInfo {
        GCPluginInfo::new("RestSomethingPlugin", "0.1.0", "0", 0)
    }

    fn receive_datapoint(&self, _data_value: GCBorrowedDatapointValue) -> bool {
        // Handle incoming datapoint
        true
    }

    fn init(_plugin_interface: &'a GCPluginInterface) -> Box<Self> {
        Box::new(RestSomethingPlugin::new())
    }
}

#[cfg(test)]
mod tests {
    use gc_plugin_abi::raw::{self, GCInfoPluginExport, GCInitPluginExport, GCReceiveDatapointPluginExport, GCShutdownPluginExport};
    use gc_utils::testing::gc_integration_test;

    /// Ensure this test breaks if any of the function signatures change
    /// If this test fails, the Rust safe ABI will have to be updated
    /// Requires the plugin to be defined above, otherwise linking will fail
    #[gc_integration_test]
    fn test_function_signatures() {
        let _gc_plugin_init_check: GCInitPluginExport = raw::gc_plugin_init;
        let _gc_plugin_shutdown_check: GCShutdownPluginExport = raw::gc_plugin_shutdown;
        let _gc_plugin_receive_datapoint_check: GCReceiveDatapointPluginExport = raw::gc_plugin_receive_datapoint;
        let _gc_plugin_get_info_check: GCInfoPluginExport = raw::gc_plugin_get_info;
    }
}