harmos-runtime 0.1.4

Harmos runtime: managed state, undo, recovery, background work and typed streams.
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

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

// Progress Retained Native Transports While Plugin Lifecycle Futures Wait.

/* === Modules === */

/* === Re-Exports === */

/* === Imports === */

// Standard Library Imports
use std::collections::BTreeMap;
use std::sync::{Arc, Mutex};
use std::task::Context;

// Third Party Imports

// Local Imports
use crate::plugin::PluginGeneration;

/* === Constants === */

/* === Macros === */

/* === Type Aliases === */

type Key = (String, PluginGeneration);
type Poller = Arc<dyn Fn(&mut Context<'_>) + Send + Sync>;
type Transports = Arc<Mutex<BTreeMap<Key, Poller>>>;

/* === Structs === */

#[derive(Clone, Default)]
pub(crate) struct Driving {
    transports: Transports,
}

#[cfg(feature = "plugin-sidecar")]
pub(crate) struct Lease {
    transports: Transports,
    key: Key,
    poller: Poller,
}

/* === Enums === */

/* === Traits === */

/* === Implementations === */

impl Driving {
    #[cfg(feature = "plugin-sidecar")]
    pub(crate) fn retain(
        &self, owner: String, generation: PluginGeneration, poll: impl Fn(&mut Context<'_>) + Send + Sync + 'static,
    ) -> Lease {
        let key = (owner, generation);
        let poller: Poller = Arc::new(poll);
        let mut transports = self.transports.lock().expect("plugin transport owner is healthy");
        assert!(!transports.contains_key(&key), "plugin generation has one physical transport");
        transports.insert(key.clone(), poller.clone());
        Lease { transports: self.transports.clone(), key, poller }
    }

    pub(crate) fn tick(&self, context: &mut Context<'_>) {
        let pollers: Vec<_> = self.transports.lock().expect("plugin transport owner is healthy").values().cloned().collect();
        for poll in pollers {
            poll(context);
        }
    }
}

#[cfg(feature = "plugin-sidecar")]
impl Drop for Lease {
    fn drop(&mut self) {
        let mut transports = self.transports.lock().expect("plugin transport owner is healthy");
        if transports.get(&self.key).is_some_and(|poller| Arc::ptr_eq(poller, &self.poller)) {
            transports.remove(&self.key);
        }
    }
}

/* === Public Functions === */

/* === Private Functions === */

/* === Tests === */