sigwake 0.0.1

A thread-safe signal-based state management library that integrates with Rust's async programming model
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

use super::*;

#[test]
fn basic_push_and_read() {
    let mut queue = SharedQueue::new();
    let mut cursor = queue.create_cursor();

    queue.push(1);
    queue.push(2);
    queue.push(3);

    let mut reader = queue.read(&mut cursor);
    assert_eq!(reader.pop(), Some(&1));
    assert_eq!(reader.pop(), Some(&2));
    assert_eq!(reader.pop(), Some(&3));
    assert_eq!(reader.pop(), None);
    drop(reader);

    queue.drop_cursor(cursor);
}

#[test]
fn multiple_cursors() {
    let mut queue = SharedQueue::new();
    let mut cursor1 = queue.create_cursor();
    let mut cursor2 = queue.create_cursor();

    queue.push(1);
    queue.push(2);

    let mut reader1 = queue.read(&mut cursor1);
    assert_eq!(reader1.pop(), Some(&1));
    assert_eq!(reader1.pop(), Some(&2));
    assert_eq!(reader1.pop(), None);
    drop(reader1);

    let mut reader2 = queue.read(&mut cursor2);
    assert_eq!(reader2.pop(), Some(&1));
    assert_eq!(reader2.pop(), Some(&2));
    assert_eq!(reader2.pop(), None);
    drop(reader2);

    queue.drop_cursor(cursor1);
    queue.drop_cursor(cursor2);
}

#[test]
fn memory_cleanup() {
    let mut queue = SharedQueue::new();
    queue.push(1);
    queue.push(2);

    let cursor = queue.create_cursor();
    queue.drop_cursor(cursor);

    assert_eq!(queue.values.len(), 0);
    assert_eq!(queue.ref_counts.len(), 1);
}

#[test]
fn memory_no_cursor() {
    let mut queue = SharedQueue::new();
    queue.push(1);
    queue.push(2);

    assert_eq!(queue.values.len(), 0);
    assert_eq!(queue.ref_counts.len(), 1);
}

#[test]
fn cursor_position_update() {
    let mut queue = SharedQueue::new();
    let mut cursor = queue.create_cursor();

    queue.push(1);
    queue.push(2);

    let mut reader = queue.read(&mut cursor);
    assert_eq!(reader.pop(), Some(&1));
    drop(reader);

    let mut reader = queue.read(&mut cursor);
    assert_eq!(reader.pop(), Some(&2));
    drop(reader);

    queue.drop_cursor(cursor);
}

#[test]
fn create_cursor_after_push() {
    let mut queue = SharedQueue::new();
    queue.push(1);
    let mut cursor = queue.create_cursor();
    queue.push(2);
    let mut reader = queue.read(&mut cursor);
    assert_eq!(reader.pop(), Some(&2));
    assert_eq!(reader.pop(), None);
    drop(reader);
    queue.drop_cursor(cursor);
}

#[test]
fn create_cursor_when_unread_value_exists() {
    let mut queue = SharedQueue::new();
    let mut cursor1 = queue.create_cursor();
    queue.push(1);
    let mut cursor2 = queue.create_cursor();
    queue.push(2);

    let mut reader2 = queue.read(&mut cursor2);
    assert_eq!(reader2.pop(), Some(&2));
    assert_eq!(reader2.pop(), None);
    drop(reader2);

    let mut reader1 = queue.read(&mut cursor1);
    assert_eq!(reader1.pop(), Some(&1));
    assert_eq!(reader1.pop(), Some(&2));
    assert_eq!(reader1.pop(), None);
    drop(reader1);
}

#[test]
#[should_panic]
fn ref_count_underflow() {
    let mut queue = SharedQueue::new();
    queue.push(1);
    queue.decrement_ref_count(0);
}