reactive-signals 0.1.0-alpha.4

reactive-signals is a dx-first scope-based fine-grained reactive system.
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
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

use std::cmp::Ordering;

use crate::arena_tree::NodeId;

use crate::{primitives::u15Bool, runtimes::RuntimeInner, scope::Scope, Runtime};

/// The SignalId has three components:
///
/// - `rt`: The Runtime id
/// - `sx`: The Scope id (actually a NodeId as the Scope is stored in an arena Tree)
/// - `id`: The id of the signal.
///
///
/// ## Ordering and equality
///
/// The SignalId doesn't use the `rt` for ordering or equality operations,
/// because it is up to the user to make sure that signals are not used
/// across runtimes.
///
/// They are ordered by Scope and then by `id`.
#[derive(Clone, Copy)]
pub(crate) struct SignalId<RT: Runtime> {
    pub(crate) id: u15Bool,
    pub(crate) sx: NodeId,
    pub(crate) rt: RT,
}

impl<RT: Runtime> SignalId<RT> {
    pub(crate) fn new(id: usize, sx: Scope<RT>) -> Self {
        Self {
            sx: sx.sx,
            id: u15Bool::new(id, false),
            rt: sx.rt,
        }
    }

    pub(crate) fn index(&self) -> usize {
        self.id.as_usize()
    }

    #[inline]
    pub(crate) fn rt_ref<F, T>(&self, f: F) -> T
    where
        F: FnOnce(&RuntimeInner<RT>) -> T,
    {
        self.rt.with_ref(f)
    }
}

impl<RT: Runtime> PartialEq for SignalId<RT> {
    #[inline]
    fn eq(&self, other: &SignalId<RT>) -> bool {
        self.id == other.id && self.sx == other.sx
    }
}

impl<RT: Runtime> Eq for SignalId<RT> {}

// ordering by NodeId (Scope) and then id. The runtime is not considered
// as it is assumed to be the same for all SignalId's running on the same
// thread
impl<RT: Runtime> PartialOrd for SignalId<RT> {
    #[inline]
    fn partial_cmp(&self, other: &SignalId<RT>) -> Option<Ordering> {
        match self.sx.partial_cmp(&other.sx) {
            Some(Ordering::Equal) => self.id.partial_cmp(&other.id),
            cmp => cmp,
        }
    }
}

impl<RT: Runtime> Ord for SignalId<RT> {
    #[inline]
    fn cmp(&self, other: &SignalId<RT>) -> Ordering {
        match self.sx.cmp(&other.sx) {
            Ordering::Equal => self.id.cmp(&other.id),
            cmp => cmp,
        }
    }
}

impl<RT: Runtime> std::fmt::Debug for SignalId<RT> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}{}ˢⁱᵍ", self.sx, self.id.as_u15())
    }
}

#[test]
fn signal_id_size() {
    use crate::runtimes::{ClientRuntime, ServerRuntime};

    assert_eq!(std::mem::size_of::<SignalId<ServerRuntime>>(), 8);
    assert_eq!(std::mem::size_of::<SignalId<ClientRuntime>>(), 4);
}

#[test]
fn signal_id_ordering() {
    use crate::runtimes::ServerRuntime;

    let sig1_scope1 = SignalId {
        id: u15Bool::new(1, false),
        sx: NodeId::from(1),
        rt: ServerRuntime::from(4),
    };

    let sig2_scope1 = SignalId {
        id: u15Bool::new(2, false),
        sx: NodeId::from(1),
        rt: ServerRuntime::from(4),
    };

    let sig1_scope2 = SignalId {
        id: u15Bool::new(1, false),
        sx: NodeId::from(2),
        rt: ServerRuntime::from(4),
    };

    let sig2_scope2 = SignalId {
        id: u15Bool::new(2, false),
        sx: NodeId::from(2),
        rt: ServerRuntime::from(4),
    };

    assert!(sig1_scope1 < sig2_scope1);
    assert!(sig1_scope2 < sig2_scope2);
    assert!(sig2_scope1 < sig1_scope2);
}