vertigo 0.14.0

Reactive Real-DOM library with SSR for Rust
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

use std::{
    cell::{Cell, RefCell},
    rc::Rc,
};

/// One registered callback, paired with the id `remove` takes back.
type Hook = (u64, Rc<dyn Fn()>);

/// Callbacks fired after a completed transaction (once `propagate` has finished,
/// before `when_connect` / disconnect).
pub(super) struct Hooks {
    next_id: Cell<u64>,
    hooks: RefCell<Vec<Hook>>,
}

impl Hooks {
    pub(super) fn new() -> Self {
        Self {
            next_id: Cell::new(1),
            hooks: RefCell::new(Vec::new()),
        }
    }

    pub(super) fn insert(&self, callback: impl Fn() + 'static) -> u64 {
        let id = self.next_id.get();
        self.next_id.set(id + 1);
        self.hooks.borrow_mut().push((id, Rc::new(callback)));
        id
    }

    pub(super) fn remove(&self, id: u64) {
        let mut hooks = self.hooks.borrow_mut();
        let removed = (hooks.iter())
            .position(|(hook_id, _)| *hook_id == id)
            .map(|at| hooks.remove(at));
        // Dropped once the list is let go: the callback may hold the resource of another hook,
        // which removes that one, here again.
        drop(hooks);
        drop(removed);
    }

    pub(super) fn fire(&self) {
        if self.hooks.borrow().is_empty() {
            return;
        }
        let hooks: Vec<_> = self
            .hooks
            .borrow()
            .iter()
            .map(|(_, hook)| hook.clone())
            .collect();
        for hook in hooks {
            hook();
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::rc::Rc;

    /// A callback can hold what removes another hook when it goes.
    #[test]
    fn remove_drops_a_hook_that_removes_another() {
        struct Removes(std::rc::Weak<Hooks>, u64);
        impl Drop for Removes {
            fn drop(&mut self) {
                if let Some(hooks) = self.0.upgrade() {
                    hooks.remove(self.1);
                }
            }
        }

        let hooks = Rc::new(Hooks::new());
        let other = hooks.insert(|| {});
        let removes = Removes(Rc::downgrade(&hooks), other);
        let first = hooks.insert(move || {
            let _ = &removes;
        });

        hooks.remove(first);

        assert!(
            hooks.hooks.borrow().is_empty(),
            "the other hook is gone too"
        );
    }

    #[test]
    fn remove_does_not_fire() {
        let hooks = Hooks::new();
        let n = Rc::new(Cell::new(0));
        let id = hooks.insert({
            let n = n.clone();
            move || n.set(1)
        });
        hooks.remove(id);
        hooks.fire();
        assert_eq!(n.get(), 0);
    }

    #[test]
    fn two_hooks_both_fire() {
        let hooks = Hooks::new();
        let a = Rc::new(Cell::new(0));
        let b = Rc::new(Cell::new(0));
        hooks.insert({
            let a = a.clone();
            move || a.set(1)
        });
        hooks.insert({
            let b = b.clone();
            move || b.set(1)
        });
        hooks.fire();
        assert_eq!(a.get(), 1);
        assert_eq!(b.get(), 1);
    }
}