gveditor-core-api 0.1.7

Graviton Core 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

use serde::{Deserialize, Serialize};

use crate::messaging::ExtensionMessages;

/// Information about a extension instance
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct ExtensionInfo {
    pub id: String,
    pub name: String,
}

/// Extensions structure
pub trait Extension {
    /// Init method of the extension
    /// This will be called when the extension is loaded
    fn init(&mut self);

    /// Unload method of the extension
    /// This will be called when the extension is unloaded
    fn unload(&mut self);

    /// Forward messages to the extension
    fn notify(&mut self, message: ExtensionMessages);

    /// Retrieve info from the exension
    fn get_info(&self) -> ExtensionInfo;
}