state-tree 4.0.1

Utility for keeping internal states of signal between 2 compiled source codes
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use state_tree::{
    apply_state_storage_patch_plan, build_state_storage_patch_plan,
    tree::{SizedType, StateTree, StateTreeSkeleton, serialize_tree_untagged},
    update_state_storage,
};

#[derive(Debug, PartialEq, Clone, Copy)]
struct DummyType(pub u64);

impl SizedType for DummyType {
    fn word_size(&self) -> u64 {
        self.0
    }
}

fn boxed<T: SizedType>(node: StateTreeSkeleton<T>) -> Box<StateTreeSkeleton<T>> {
    Box::new(node)
}

#[test]
fn test_update_state_storage_reorders_nodes() {
    let delay_node = StateTree::Delay {
        readidx: 5,
        writeidx: 6,
        data: vec![10, 11],
    };
    let mem_node = StateTree::Mem {
        data: vec![100, 101, 102],
    };
    let feed_node = StateTree::Feed { data: vec![7] };

    let old_tree = StateTree::FnCall(vec![
        delay_node.clone(),
        mem_node.clone(),
        feed_node.clone(),
    ]);
    let old_skeleton = StateTreeSkeleton::FnCall(vec![
        boxed(StateTreeSkeleton::Delay { len: 2 }),
        boxed(StateTreeSkeleton::Mem(DummyType(3))),
        boxed(StateTreeSkeleton::Feed(DummyType(1))),
    ]);

    let flat_input = serialize_tree_untagged(old_tree.clone());

    let new_skeleton = StateTreeSkeleton::FnCall(vec![
        boxed(StateTreeSkeleton::Mem(DummyType(3))),
        boxed(StateTreeSkeleton::Delay { len: 2 }),
        boxed(StateTreeSkeleton::Feed(DummyType(1))),
    ]);

    let expected_len = new_skeleton.total_size() as usize;

    let updated = update_state_storage(&flat_input, old_skeleton, new_skeleton)
        .expect("update_state_storage should succeed")
        .expect("tree structures differ, patches should be generated");

    assert_eq!(updated.len(), expected_len);

    let expected_flat = vec![100, 101, 102, 0, 0, 0, 0, 7];
    assert_eq!(updated, expected_flat);
}

#[test]
fn test_update_state_storage_nested_child_insertion() {
    let delay_node = StateTree::Delay {
        readidx: 21,
        writeidx: 22,
        data: vec![1, 2],
    };
    let mem_left = StateTree::Mem { data: vec![8, 9] };
    let feed_existing = StateTree::Feed { data: vec![77] };
    let mem_right = StateTree::Mem {
        data: vec![5, 6, 7],
    };

    let old_tree = StateTree::FnCall(vec![StateTree::FnCall(vec![
        delay_node.clone(),
        mem_left.clone(),
        feed_existing.clone(),
        mem_right.clone(),
    ])]);

    let old_skeleton = StateTreeSkeleton::FnCall(vec![boxed(StateTreeSkeleton::FnCall(vec![
        boxed(StateTreeSkeleton::Delay { len: 2 }),
        boxed(StateTreeSkeleton::Mem(DummyType(2))),
        boxed(StateTreeSkeleton::Feed(DummyType(1))),
        boxed(StateTreeSkeleton::Mem(DummyType(3))),
    ]))]);

    let flat_input = serialize_tree_untagged(old_tree.clone());

    let new_skeleton = StateTreeSkeleton::FnCall(vec![boxed(StateTreeSkeleton::FnCall(vec![
        boxed(StateTreeSkeleton::Mem(DummyType(2))),
        boxed(StateTreeSkeleton::Feed(DummyType(2))),
        boxed(StateTreeSkeleton::Delay { len: 2 }),
        boxed(StateTreeSkeleton::Feed(DummyType(1))),
        boxed(StateTreeSkeleton::Mem(DummyType(3))),
    ]))]);

    let updated = update_state_storage(&flat_input, old_skeleton, new_skeleton)
        .expect("update_state_storage should succeed")
        .expect("structural changes should generate patches");

    let expected_flat = vec![8, 9, 0, 0, 0, 0, 0, 0, 77, 5, 6, 7];
    assert_eq!(updated, expected_flat);
}

#[test]
fn test_patch_plan_then_apply_matches_update_state_storage() {
    let old_tree = StateTree::FnCall(vec![StateTree::FnCall(vec![
        StateTree::Delay {
            readidx: 3,
            writeidx: 4,
            data: vec![1, 2],
        },
        StateTree::Mem { data: vec![8, 9] },
        StateTree::Feed { data: vec![99] },
    ])]);

    let old_skeleton = StateTreeSkeleton::FnCall(vec![boxed(StateTreeSkeleton::FnCall(vec![
        boxed(StateTreeSkeleton::Delay { len: 2 }),
        boxed(StateTreeSkeleton::Mem(DummyType(2))),
        boxed(StateTreeSkeleton::Feed(DummyType(1))),
    ]))]);
    let new_skeleton = StateTreeSkeleton::FnCall(vec![boxed(StateTreeSkeleton::FnCall(vec![
        boxed(StateTreeSkeleton::Mem(DummyType(2))),
        boxed(StateTreeSkeleton::Delay { len: 2 }),
        boxed(StateTreeSkeleton::Feed(DummyType(1))),
    ]))]);

    let old_flat = serialize_tree_untagged(old_tree);

    let patch_plan = build_state_storage_patch_plan(old_skeleton.clone(), new_skeleton.clone())
        .expect("patch plan should be generated");
    let by_plan = apply_state_storage_patch_plan(&old_flat, &patch_plan);

    let by_legacy = update_state_storage(&old_flat, old_skeleton, new_skeleton)
        .expect("legacy update_state_storage should succeed")
        .expect("legacy update_state_storage should produce migrated storage");

    assert_eq!(by_plan, by_legacy);
}