completion 0.2.1

Utilities for writing completion-based asynchronous code
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

#![deny(warnings)]
#![deny(
    absolute_paths_not_starting_with_crate,
    box_pointers,
    explicit_outlives_requirements,
    keyword_idents,
    macro_use_extern_crate,
    meta_variable_misuse,
    missing_copy_implementations,
    missing_crate_level_docs,
    missing_debug_implementations,
    missing_doc_code_examples,
    missing_docs,
    pointer_structural_match,
    private_doc_tests,
    single_use_lifetimes,
    trivial_casts,
    trivial_numeric_casts,
    unaligned_references,
    unreachable_pub,
    unsafe_code,
    unstable_features,
    unused_extern_crates,
    unused_import_braces,
    unused_lifetimes,
    unused_qualifications,
    unused_results,
    variant_size_differences
)]
#![deny(clippy::pedantic)]

use completion_core::CompletionStream;
use futures_lite::future::yield_now;
use futures_lite::pin;

use crate::{completion_async, completion_stream, future::block_on, CompletionStreamExt};

#[test]
fn empty() {
    block_on(completion_async! {
        let stream = completion_stream!();
        pin!(stream);
        assert_eq!(stream.next().await, None);
    });
}

#[test]
fn side_effects() {
    block_on(completion_async! {
        let mut ran = false;

        {
            let ran = &mut ran;

            let stream = completion_stream! {
                *ran = true;
            };
            pin!(stream);
            assert_eq!(stream.next().await, None);
        }

        assert!(ran);
    });
}

#[test]
fn yielding() {
    block_on(completion_async! {
        let stream = completion_stream! {
            yield_now().await;
            yield_now().await;
            yield 1;
            yield_now().await;
            yield_now().await;
            yield 2;
            yield_now().await;
            yield 3;
        };

        assert_eq!(stream.collect::<Vec<_>>().await, [1, 2, 3]);
    });
}

#[test]
fn return_from_stream() {
    block_on(completion_async! {
        #[allow(unreachable_code)]
        let stream = completion_stream! {
            yield 1;
            return;
            yield 2;
        };

        assert_eq!(stream.collect::<Vec<_>>().await, [1]);
    });
}

#[test]
fn try_result() {
    block_on(completion_async! {
        let stream = completion_stream! {
            yield Ok::<_, i32>("");

            let res = Ok::<_, i8>(());
            res?;

            let res = Err(5_i8);
            res?;

            unreachable!();
        };

        pin!(stream);
        assert_eq!(stream.next().await, Some(Ok("")));
        assert_eq!(stream.next().await, Some(Err(5)));
        assert_eq!(stream.next().await, None);
    });
}

#[test]
fn try_option() {
    block_on(completion_async! {
        let stream = completion_stream! {
            yield Some(5);

            let res = Some("");
            let _ = res?;

            let res = None;
            res?;

            unreachable!();
        };

        pin!(stream);
        assert_eq!(stream.next().await, Some(Some(5)));
        assert_eq!(stream.next().await, Some(None));
        assert_eq!(stream.next().await, None);
    });
}

#[test]
fn r#return() {
    fn returns_stream() -> impl CompletionStream<Item = i32> {
        completion_stream! {
            yield 1;
            yield 2;
            yield 3;
            yield_now().await;
        }
    }

    block_on(completion_async! {
        assert_eq!(returns_stream().collect::<Vec<_>>().await, [1, 2, 3]);
    });
}

#[test]
fn nested() {
    let stream_1 = completion_stream! {
        for i in 0..3 {
            yield i;
        }
    };
    pin!(stream_1);

    let stream_2 = completion_stream! {
        while let Some(item) = stream_1.next().await {
            yield item * 2;
        }
    };

    assert_eq!(block_on(stream_2.collect::<Vec<_>>()), [0, 2, 4]);
}

#[test]
fn send() {
    fn requires_send<T: Send>(_: T) {}

    requires_send(completion_stream! {});
    requires_send(completion_stream! {
        yield_now().await;
    });
}