allwright-core 0.0.49

Lightweight allwright engine core with shared client and transport APIs.
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

#[cfg(feature = "client")]
mod client;
#[cfg(feature = "server")]
#[path = "engine.rs"]
mod engine_lib;
#[cfg(feature = "server")]
mod plugin_loader;
#[cfg(feature = "server")]
mod plugin_runtime;

pub mod proto {
    include!("proto_generated.rs");
    pub use self::allwright::engine::v1::*;
}

pub mod plugins {
    #[cfg(feature = "server")]
    pub use crate::plugin_runtime::{
        InstalledPlugin, ensure_plugin_available, install_plugin, installed_plugins, invoke_plugin,
        plugin_runtime_artifact_path,
    };
    pub use allwright_plugin_sdk::{SurfaceFamily, SurfacePluginDescriptor};

    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct PluginPackage {
        pub id: &'static str,
        pub family: SurfaceFamily,
        pub package_name: &'static str,
        pub version: &'static str,
        pub description: &'static str,
    }

    const PLUGINS: [PluginPackage; 6] = [
        PluginPackage {
            id: "web",
            family: SurfaceFamily::Web,
            package_name: "allwright-surface-web",
            version: env!("CARGO_PKG_VERSION"),
            description: "Web surface plugin for the allwright engine.",
        },
        PluginPackage {
            id: "mobile-android",
            family: SurfaceFamily::Mobile,
            package_name: "allwright-surface-mobile-android",
            version: env!("CARGO_PKG_VERSION"),
            description: "Android mobile surface plugin for the allwright engine.",
        },
        PluginPackage {
            id: "mobile-ios",
            family: SurfaceFamily::Mobile,
            package_name: "allwright-surface-mobile-ios",
            version: env!("CARGO_PKG_VERSION"),
            description: "iOS mobile surface plugin for the allwright engine.",
        },
        PluginPackage {
            id: "desktop-mac",
            family: SurfaceFamily::Desktop,
            package_name: "allwright-surface-desktop-mac",
            version: env!("CARGO_PKG_VERSION"),
            description: "macOS desktop surface plugin for the allwright engine.",
        },
        PluginPackage {
            id: "desktop-windows",
            family: SurfaceFamily::Desktop,
            package_name: "allwright-surface-desktop-windows",
            version: env!("CARGO_PKG_VERSION"),
            description: "Windows desktop surface plugin for the allwright engine.",
        },
        PluginPackage {
            id: "desktop-linux",
            family: SurfaceFamily::Desktop,
            package_name: "allwright-surface-desktop-linux",
            version: env!("CARGO_PKG_VERSION"),
            description: "Linux desktop surface plugin for the allwright engine.",
        },
    ];

    pub fn catalog() -> &'static [PluginPackage] {
        &PLUGINS
    }

    pub fn package(plugin_id: &str) -> Option<&'static PluginPackage> {
        catalog().iter().find(|plugin| plugin.id == plugin_id)
    }

    pub fn descriptors() -> Vec<SurfacePluginDescriptor> {
        catalog()
            .iter()
            .map(|plugin| SurfacePluginDescriptor {
                id: plugin.id,
                family: plugin.family,
                version: plugin.version,
                description: plugin.description,
            })
            .collect()
    }
}

#[cfg(feature = "client")]
pub use client::*;
#[cfg(feature = "server")]
pub use engine_lib::serve;