ng-gateway-sdk 0.1.0

SDK for building NG Gateway southward drivers and northward 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

//! Low-frequency model conversion contracts.
//!
//! These traits define how database/API models are converted into runtime trait objects
//! used by the gateway core and drivers/plugins.
//!
//! # Constraints (MUST)
//! - MUST be deterministic and side-effect free.
//! - MUST NOT perform any network/blocking I/O.
//! - MUST validate input models and return actionable errors.

use crate::{
    northward::PluginConfig,
    southward::{
        model::{ActionModel, ChannelModel, DeviceModel, PointModel},
        RuntimeAction, RuntimeChannel, RuntimeDevice, RuntimePoint,
    },
    DriverResult, NorthwardResult,
};
use std::sync::Arc;

/// Convert southward models into runtime trait objects.
pub trait SouthwardModelConverter: Send + Sync + 'static {
    fn convert_runtime_channel(
        &self,
        channel: ChannelModel,
    ) -> DriverResult<Arc<dyn RuntimeChannel>>;
    fn convert_runtime_device(&self, device: DeviceModel) -> DriverResult<Arc<dyn RuntimeDevice>>;
    fn convert_runtime_point(&self, point: PointModel) -> DriverResult<Arc<dyn RuntimePoint>>;
    fn convert_runtime_action(&self, action: ActionModel) -> DriverResult<Arc<dyn RuntimeAction>>;
}

/// Convert northward plugin config JSON into a typed config object.
pub trait NorthwardModelConverter: Send + Sync + 'static {
    fn convert_plugin_config(
        &self,
        config: serde_json::Value,
    ) -> NorthwardResult<Arc<dyn PluginConfig>>;
}