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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
use crate::{
ActError, ActPackageMeta, ActRunAs, Result, env::ActUserVar, scheduler::Runtime, store::KvStore,
};
use core::fmt;
use std::sync::Arc;
#[derive(Clone)]
pub struct Extender {
runtime: Arc<Runtime>,
}
impl fmt::Debug for Extender {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Extender").finish()
}
}
impl Extender {
pub(crate) fn new(runtime: &Arc<Runtime>) -> Self {
Self {
runtime: runtime.clone(),
}
}
/// register module
///
/// ## Example
/// ```no_run
/// use acts::Engine;
/// mod test_module {
/// use acts::{ActUserVar, Vars, Result};
/// #[derive(Clone)]
/// pub struct TestModule;
/// impl ActUserVar for TestModule {
/// fn name(&self) -> String {
/// "my_var".to_string()
/// }
///
/// fn default_data(&self) -> Option<Vars> {
/// None
/// }
/// }
/// }
/// let engine = Engine::new().start().unwrap();
/// let module = test_module::TestModule;
/// engine.extender().register_var(&module);
/// ```
pub fn register_var<T: ActUserVar + Clone + 'static>(&self, module: &T) {
self.runtime.env().register_var(module)
}
/// register package with meta definition
/// ## Example
/// ```no_run
/// use acts::{ActPackage, ActPackageMeta, Vars};
/// use serde::{Deserialize, Serialize};
/// use serde_json::json;
///
/// #[derive(Debug, Clone, Deserialize, Serialize)]
/// pub struct MyPackage {
/// a: i32,
/// b: Vec<String>,
/// }
/// impl ActPackage for MyPackage {
/// fn meta() -> ActPackageMeta {
/// ActPackageMeta {
/// id: "my_package",
/// name: "my package",
/// desc: "",
/// icon: "",
/// doc: "",
/// version: "0.1.0",
/// schema: json!({
/// "type": "object",
/// "properties": {
/// "a": { "type": "number" },
/// "b": { "type": "array" }
/// }
/// }),
/// // refers to https://github.com/rjsf-team/react-jsonschema-form
/// options: None,
/// run_as: acts::ActRunAs::Irq,
/// resources: vec![],
/// catalog: acts::ActPackageCatalog::App,
/// }
/// }
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let engine = acts::Engine::new().start().unwrap();
/// engine.extender().register_package(&MyPackage::meta()).unwrap();
/// }
pub fn register_package(&self, meta: &ActPackageMeta) -> Result<()> {
if meta.run_as == ActRunAs::Func {
return Err(ActError::Package(
"package run_as must be one of Irq and Msg".to_string(),
));
}
let package = meta.into_data()?;
self.runtime.cache().store().publish(&package)?;
Ok(())
}
/// register collection
/// ## Example
///
/// ```no_run
/// use acts::{Engine, Result, KvStore, ScanOptions, data};
/// use std::sync::Arc;
///
/// pub struct MyStore;
/// impl KvStore for MyStore {
/// fn get(&self, key: &str) -> Result<Option<Vec<u8>>> {
/// Ok(None)
/// }
///
/// fn put(&self, key: &str, value: Vec<u8>) -> Result<()> {
/// Ok(())
/// }
///
/// fn delete(&self, key: &str) -> Result<()> {
/// Ok(())
/// }
///
/// fn scan_prefix(&self, key: &str, options: ScanOptions) -> Result<Vec<(String, Vec<u8>)>> {
/// Ok(vec![])
/// }
///
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let engine = acts::Engine::new().start().unwrap();
/// let store: Arc<dyn KvStore + 'static> = Arc::new(MyStore);
/// engine.extender().register_store(store);
/// }
pub fn register_store(&self, store: Arc<dyn KvStore + 'static>) {
self.runtime.store().register(store);
}
}