harmos-runtime 0.1.6

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

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports

// Third Party Imports
use tokio::sync::broadcast;
// Local Imports
use super::{PluginGeneration, PluginState};

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

pub struct PluginEvents {
    pub(super) receiver: broadcast::Receiver<PluginEvent>,
}

/* === Enums === */

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PluginEventKind {
    DefinitionChanged,
    Initializing,
    Available,
    Stopping,
    Failed,
    Stopped,
    Removed,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum PluginEvent {
    Changed { id: String, generation: Option<PluginGeneration>, state: PluginState, revision: u64, kind: PluginEventKind },
    Lagged { missed: u64 },
}

/* === Traits === */

/* === Implementations === */

impl PluginEvents {
    pub async fn next(&mut self) -> Option<PluginEvent> {
        match self.receiver.recv().await {
            Ok(event) => Some(event),
            Err(broadcast::error::RecvError::Lagged(missed)) => Some(PluginEvent::Lagged { missed }),
            Err(broadcast::error::RecvError::Closed) => None,
        }
    }
}

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

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

/* === Tests === */