yao 0.1.4

a fast, tiny, extensiable workflow engine
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

use crate::{
    debug,
    plugin::{org::OrgPlugin, role::RolePlugin},
    Engine,
};

mod org;
mod role;

#[cfg(test)]
mod tests;

/// Act plugin trait
///
/// ## Example
///
/// ```rust
/// use yao::{ActPlugin, Message, Engine, Workflow};
/// #[derive(Clone)]
/// struct TestPlugin;
///
/// impl TestPlugin {
///     fn new() -> Self {
///         Self
///     }
/// }
///
/// impl ActPlugin for TestPlugin {
///     fn on_init(&self, engine: &Engine) {
///         println!("TestPlugin");
///         // engine.register_module("name", module);
///         // engine.register_action("func", func);
///         engine.on_workflow_start(|w: &Workflow| {});
///         engine.on_workflow_complete(|w: &Workflow| {});
///         engine.on_message(|msg: &Message| {});
///     }
/// }
/// ```
pub trait ActPlugin: Send + Sync {
    fn on_init(&self, engine: &Engine);
}

pub async fn init(engine: &Engine) {
    debug!("plugin::init");
    let mut plugins = &mut *engine.plugins.lock().unwrap();

    register_plugins_default(&mut plugins);
    for plugin in plugins.into_iter() {
        plugin.on_init(engine);
    }
}

fn register_plugins_default(plugins: &mut Vec<Box<dyn ActPlugin>>) {
    #[cfg(feature = "role")]
    plugins.push(Box::new(RolePlugin::new()));

    #[cfg(feature = "org")]
    plugins.push(Box::new(OrgPlugin::new()));
}

impl Engine {
    /// register plugin
    ///
    /// ## Example
    ///
    /// ```no_run
    /// use yao::{ActPlugin, Message, Engine, Workflow};
    ///
    /// #[derive(Clone)]
    /// struct TestPlugin;
    /// impl TestPlugin {
    ///     fn new() -> Self {
    ///         Self
    ///     }
    /// }
    /// impl ActPlugin for TestPlugin {
    ///     fn on_init(&self, engine: &Engine) {
    ///         println!("TestPlugin");
    ///         // engine.register_module("name", module);
    ///         // engine.register_action("func", func);
    ///         engine.on_workflow_start(|_w: &Workflow| {});
    ///         engine.on_workflow_complete(|_w: &Workflow| {});
    ///         engine.on_message(|_msg: &Message| {});
    ///     }
    /// }
    /// let engine = Engine::new();
    /// engine.register_plugin(&TestPlugin::new());
    /// ```
    pub fn register_plugin<T: ActPlugin + 'static + Clone>(&self, plugin: &T) {
        self.plugins.lock().unwrap().push(Box::new(plugin.clone()));
    }
}