compact-waitgroup 0.3.6

A compact asynchronous WaitGroup synchronization primitive.
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

use core::pin::Pin;
use core::task::{Context, Poll};

use futures_test::task::new_count_waker;

use crate::{MonoWaitGroup, WaitGroup};

#[cfg_attr(not(loom), test)]
pub fn test_wg_done() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);
    let (wg, token) = WaitGroup::new();
    let mut rx = core::pin::pin!(wg);
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Pending);
    token.release();
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(counter.get(), 1);
}

#[cfg_attr(not(loom), test)]
pub fn test_wg_done_twice() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);
    let (wg, token) = WaitGroup::new();
    let (token_a, token_b) = token.scope(|token| (token.clone(), token));
    let mut rx = core::pin::pin!(wg);
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Pending);
    token_b.release();
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Pending);
    token_a.release();
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(counter.get(), 1);
}

#[cfg_attr(not(loom), test)]
pub fn test_wg_done_twice_rev() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);
    let (wg, token) = WaitGroup::new();
    let (token_a, token_b) = token.scope(|token_a| {
        let token_b = token_a.clone();
        (token_a, token_b)
    });
    let mut rx = core::pin::pin!(wg);
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Pending);
    token_b.release();
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Pending);
    token_a.release();
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(counter.get(), 1);
}

#[cfg_attr(not(loom), test)]
pub fn test_mono_wg_done() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);
    let (wg, token) = MonoWaitGroup::new();
    let mut rx = core::pin::pin!(wg);
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Pending);
    token.release();
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(counter.get(), 1);
}

#[cfg_attr(not(loom), test)]
pub fn test_wg_send_before_poll() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);
    let (wg, token) = WaitGroup::new();
    token.release();
    let mut rx = core::pin::pin!(wg);
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(counter.get(), 0);
}

#[cfg_attr(not(loom), test)]
pub fn test_mono_wg_send_before_poll() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);
    let (wg, token) = MonoWaitGroup::new();
    token.release();
    let mut rx = core::pin::pin!(wg);
    assert_eq!(rx.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(counter.get(), 0);
}

#[cfg_attr(not(loom), test)]
pub fn test_wg_drop_before_send() {
    let (wg, token) = WaitGroup::new();
    drop(wg);
    token.release();
}

#[cfg_attr(not(loom), test)]
pub fn test_mono_wg_drop_before_send() {
    let (wg, token) = MonoWaitGroup::new();
    drop(wg);
    token.release();
}

#[cfg_attr(not(loom), test)]
pub fn test_wg_poll_by_others() {
    let (waker_a, counter_a) = new_count_waker();
    let (waker_b, counter_b) = new_count_waker();

    let (wg, token) = WaitGroup::new();
    let mut wg = core::pin::pin!(wg);

    let mut cx = Context::from_waker(&waker_a);
    assert_eq!(wg.as_mut().poll(&mut cx), Poll::Pending);
    assert_eq!(counter_a.get(), 0);

    let mut cx = Context::from_waker(&waker_b);
    assert_eq!(wg.as_mut().poll(&mut cx), Poll::Pending);
    assert_eq!(counter_a.get(), 0);
    assert_eq!(counter_b.get(), 0);

    token.release();

    assert_eq!(counter_a.get(), 0);
    assert_eq!(counter_b.get(), 1);

    assert_eq!(wg.as_mut().poll(&mut cx), Poll::Ready(()));
    assert_eq!(wg.as_mut().poll(&mut cx), Poll::Ready(()));

    assert_eq!(counter_a.get(), 0);
    assert_eq!(counter_b.get(), 1);
}

#[cfg_attr(not(loom), test)]
pub fn test_wg_drop_early() {
    let (waker, counter) = new_count_waker();
    let mut cx = Context::from_waker(&waker);

    let (mut wg, token) = WaitGroup::new();
    let pinned_wg = Pin::new(&mut wg);
    assert_eq!(pinned_wg.poll(&mut cx), Poll::Pending);

    drop(wg);

    token.release();
    assert_eq!(counter.get(), 0);
}