Skip to main content

kernel/
signal_router.rs

1// Copyright 2026 Mark AB (markik)
2// SPDX-License-Identifier: MIT OR Apache-2.0
3
4//! Portable signal-subscription seam for frame-bound inbox consumers.
5
6use futures_util::stream::BoxStream;
7
8/// Host-provided subscription router for shell-facing runtime signals.
9pub trait SignalRouter: Send + Sync {
10    fn subscribe(&self, topic: SignalTopic) -> BoxStream<'static, SignalEnvelope>;
11}
12
13#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
14pub enum SignalTopic {
15    Lifecycle,
16    RegistryEvent,
17}
18
19#[derive(Debug, Clone, PartialEq, Eq)]
20pub enum SignalEnvelope {
21    Lifecycle(LifecycleSignal),
22    RegistryEvent(RegistrySignal),
23}
24
25impl SignalEnvelope {
26    pub fn topic(&self) -> SignalTopic {
27        match self {
28            Self::Lifecycle(..) => SignalTopic::Lifecycle,
29            Self::RegistryEvent(..) => SignalTopic::RegistryEvent,
30        }
31    }
32}
33
34#[derive(Debug, Clone, PartialEq, Eq)]
35pub enum LifecycleSignal {
36    SemanticIndexUpdated { indexed_nodes: usize },
37}
38
39#[derive(Debug, Clone, PartialEq, Eq)]
40pub enum RegistrySignal {
41    WorkbenchProjectionRefreshRequested,
42    SettingsRouteRequested { url: String },
43    ThemeChanged,
44    LensChanged,
45    PhysicsProfileChanged,
46    CanvasProfileChanged,
47    WorkbenchSurfaceChanged,
48}
49
50#[cfg(test)]
51mod tests {
52    use super::{LifecycleSignal, RegistrySignal, SignalEnvelope, SignalTopic};
53
54    #[test]
55    fn lifecycle_envelope_reports_lifecycle_topic() {
56        let envelope =
57            SignalEnvelope::Lifecycle(LifecycleSignal::SemanticIndexUpdated { indexed_nodes: 3 });
58
59        assert_eq!(envelope.topic(), SignalTopic::Lifecycle);
60    }
61
62    #[test]
63    fn registry_envelope_reports_registry_topic() {
64        let envelope =
65            SignalEnvelope::RegistryEvent(RegistrySignal::WorkbenchProjectionRefreshRequested);
66
67        assert_eq!(envelope.topic(), SignalTopic::RegistryEvent);
68    }
69}