magic-orb 0.4.1

Implementation of thread-safe, overwrite, heap-stored, fix-sized, locking Ring buffer
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
143
144
145
146
147
148
149
150
151
152

use magic_orb::MagicOrb;

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;
    use std::thread;

    #[test]
    fn test_new_default() {
        let orb: MagicOrb<i32> = MagicOrb::new_default(5);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![0, 0, 0, 0, 0]);
    }

    #[test]
    fn test_new_with_value() {
        let orb = MagicOrb::new(5, 7);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![7, 7, 7, 7, 7]);
    }

    #[test]
    fn test_from_vec() {
        let data = vec![1, 2, 3, 4, 5];
        let orb = MagicOrb::from(data);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![1, 2, 3, 4, 5]);
    }

    #[test]
    fn test_push_non_wrapping() {
        let orb = MagicOrb::from(vec![1, 2, 3, 4, 5]);
        orb.push_slice_overwrite(&[6, 7]);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![3, 4, 5, 6, 7]);
    }

    #[test]
    fn test_push_wrapping() {
        let orb = MagicOrb::from(vec![1, 2, 3, 4, 5]);
        orb.push_slice_overwrite(&[6, 7, 8, 9, 10]);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![6, 7, 8, 9, 10]);
    }

    #[test]
    fn test_push_wrapping_partial_1() {
        let orb = MagicOrb::from(vec![1, 2, 3, 4, 5]);
        orb.push_slice_overwrite(&[6, 7, 8, 9]);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![5, 6, 7, 8, 9]);
    }

    #[test]
    fn test_push_larger_than_buffer() {
        let orb = MagicOrb::from(vec![1, 2, 3, 4, 5]);
        orb.push_slice_overwrite(&[10, 11, 12, 13, 14, 15, 16]);
        let result = orb.get_contiguous();
        assert_eq!(result, vec![12, 13, 14, 15, 16]);
    }

    #[test]
    fn test_multithreaded_push() {
        let orb = Arc::new(MagicOrb::new(1000, 0usize));
        let mut handles = vec![];

        for i in 0..10 {
            let orb_clone = Arc::clone(&orb);
            handles.push(thread::spawn(move || {
                let data: Vec<usize> = (i * 100..(i + 1) * 100).collect();
                orb_clone.push_slice_overwrite(&data);
            }));
        }

        for handle in handles {
            handle.join().unwrap();
        }

        let result = orb.get_contiguous();

        assert_eq!(result.iter().sum::<usize>(), 500 * 999usize);
    }

    #[test]
    fn test_pop_front_from_full_orb() {
        let orb = MagicOrb::from(vec![1, 2, 3, 4, 5]);
        assert_eq!(orb.len(), 5);
        orb.pop_back();
        assert_eq!(orb.len(), 4);
        let contents = orb.get_contiguous();
        assert_eq!(contents, vec![1, 2, 3, 4]);
    }

    #[test]
    fn test_pop_front_until_empty() {
        let orb = MagicOrb::from(vec![1, 2, 3]);
        assert_eq!(orb.len(), 3);
        orb.pop_back();
        assert_eq!(orb.len(), 2);
        let contents = orb.get_contiguous();
        assert_eq!(contents, vec![1, 2]);

        orb.pop_back();
        assert_eq!(orb.len(), 1);
        let contents = orb.get_contiguous();
        assert_eq!(contents, vec![1]);

        orb.pop_back();
        assert_eq!(orb.len(), 0);
        assert!(orb.is_empty());
        let contents = orb.get_contiguous();
        assert!(contents.is_empty());
    }

    #[test]
    fn test_pop_front_from_empty_orb() {
        let orb = MagicOrb::new(5, 0);
        assert_eq!(orb.len(), 5);
        for _ in 0..5 {
            orb.pop_back();
        }
        assert_eq!(orb.len(), 0);

        orb.pop_back();
        assert_eq!(orb.len(), 0);
        assert!(orb.is_empty());
    }

    #[test]
    fn test_pop_front_after_push_and_overwrite() {
        let orb = MagicOrb::new_default(4);
        orb.push_slice_overwrite(&[1, 2, 3, 4, 5, 6]);
        assert_eq!(orb.len(), 4);
        let contents = orb.get_contiguous();
        assert_eq!(contents, vec![3, 4, 5, 6]);

        orb.pop_back();
        orb.pop_back();
        orb.push_slice_overwrite(&[7]);
        assert_eq!(orb.len(), 3);
        let contents = orb.get_contiguous();
        assert_eq!(contents, vec![3, 4, 7]);

        orb.push_slice_overwrite(&[9, 10]);
        assert_eq!(orb.get_contiguous(), vec![4, 7, 9, 10]);
        orb.pop_back();
        assert_eq!(orb.len(), 3);
        let contents = orb.get_contiguous();
        assert_eq!(contents, vec![4, 7, 9]);
    }
}