moon_pdk_api 2.0.3

Core APIs for creating moon WASM plugins.
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
47
48
49
50
51
52
53

use crate::common::{InitializePluginInput, InitializePluginOutput};
use crate::context::MoonContext;
use moon_common::Id;
use schematic::Schema;
use warpgate_api::*;

pub type InitializeExtensionInput = InitializePluginInput;
pub type InitializeExtensionOutput = InitializePluginOutput;

// METADATA

api_struct!(
    /// Input passed to the `register_extension` function.
    pub struct RegisterExtensionInput {
        /// ID of the extension, as it was configured.
        pub id: Id,
    }
);

api_struct!(
    /// Output returned from the `register_extension` function.
    pub struct RegisterExtensionOutput {
        /// Name of the extension.
        pub name: String,

        /// Optional description about what the extension does.
        pub description: Option<String>,

        /// Version of the plugin.
        pub plugin_version: String,
    }
);

api_struct!(
    /// Output returned from the `define_extension_config` function.
    pub struct DefineExtensionConfigOutput {
        /// Schema shape of the extension's configuration.
        pub schema: Schema,
    }
);

// EXECUTE

api_struct!(
    /// Input passed to the `execute_extension` function.
    pub struct ExecuteExtensionInput {
        /// Custom arguments passed on the command line.
        pub args: Vec<String>,

        /// Current moon context.
        pub context: MoonContext,
    }
);