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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/// Utility function for plugging callbags together in chain.
///
/// This utility actually doesn't rely on Callbag specifics, and is really similar to
/// [Ramda's `pipe`][ramda-pipe] or [lodash's `flow`][lodash-flow].
///
/// This exists to play nicely with the ecosystem, and to facilitate the import of the function.
///
/// See <https://github.com/staltz/callbag-pipe/blob/a2e5b985ce7aa55de2749e1c3e08867f45edc6fa/readme.js#L110-L114>
///
/// # Examples
///
/// Create a source with `pipe!`, then pass it to a [`for_each`]:
///
/// ```no_run
/// use async_executors::TimerExt;
/// use async_nursery::Nursery;
/// use crossbeam_queue::SegQueue;
/// use std::{sync::Arc, time::Duration};
///
/// use callbag::{combine, for_each, interval, map, pipe, take};
///
/// let (nursery, nursery_out) = Nursery::new(async_executors::AsyncStd);
///
/// let actual = Arc::new(SegQueue::new());
///
/// let source = pipe!(
/// combine!(
/// interval(Duration::from_millis(100), nursery.clone()),
/// interval(Duration::from_millis(350), nursery.clone()),
/// ),
/// map(|(x, y)| format!("X{},Y{}", x, y)),
/// take(10),
/// );
///
/// for_each({
/// let actual = Arc::clone(&actual);
/// move |x: String| {
/// println!("{:?}", x);
/// actual.push(x.clone());
/// }
/// })(source);
///
/// let nursery_out = nursery.timeout(Duration::from_millis(1_100), nursery_out);
/// drop(nursery);
/// async_std::task::block_on(nursery_out);
///
/// assert_eq!(
/// &{
/// let mut v = vec![];
/// for _i in 0..actual.len() {
/// v.push(actual.pop().unwrap());
/// }
/// v
/// }[..],
/// [
/// "X2,Y0",
/// "X3,Y0",
/// "X4,Y0",
/// "X5,Y0",
/// "X6,Y0",
/// "X6,Y1",
/// "X7,Y1",
/// "X8,Y1",
/// "X9,Y1",
/// "X9,Y2",
/// ]
/// );
/// ```
///
/// Or use `pipe!` to go all the way from source to sink:
///
/// ```no_run
/// use async_executors::TimerExt;
/// use async_nursery::Nursery;
/// use crossbeam_queue::SegQueue;
/// use std::{sync::Arc, time::Duration};
///
/// use callbag::{combine, for_each, interval, map, pipe, take};
///
/// let (nursery, nursery_out) = Nursery::new(async_executors::AsyncStd);
///
/// let actual = Arc::new(SegQueue::new());
///
/// let source = pipe!(
/// combine!(
/// interval(Duration::from_millis(100), nursery.clone()),
/// interval(Duration::from_millis(350), nursery.clone()),
/// ),
/// map(|(x, y)| format!("X{},Y{}", x, y)),
/// take(10),
/// for_each({
/// let actual = Arc::clone(&actual);
/// move |x: String| {
/// println!("{:?}", x);
/// actual.push(x.clone());
/// }
/// }),
/// );
///
/// let nursery_out = nursery.timeout(Duration::from_millis(1_100), nursery_out);
/// drop(nursery);
/// async_std::task::block_on(nursery_out);
///
/// assert_eq!(
/// &{
/// let mut v = vec![];
/// for _i in 0..actual.len() {
/// v.push(actual.pop().unwrap());
/// }
/// v
/// }[..],
/// [
/// "X2,Y0",
/// "X3,Y0",
/// "X4,Y0",
/// "X5,Y0",
/// "X6,Y0",
/// "X6,Y1",
/// "X7,Y1",
/// "X8,Y1",
/// "X9,Y1",
/// "X9,Y2",
/// ]
/// );
/// ```
///
/// # Nesting
///
/// To use `pipe!` inside another `pipe!`, you need to give the inner `pipe!` an argument, e.g.
/// `|s| pipe!(s, ...`:
///
/// ```no_run
/// use async_executors::TimerExt;
/// use async_nursery::Nursery;
/// use crossbeam_queue::SegQueue;
/// use std::{sync::Arc, time::Duration};
///
/// use callbag::{combine, for_each, interval, map, pipe, take};
///
/// let (nursery, nursery_out) = Nursery::new(async_executors::AsyncStd);
///
/// let actual = Arc::new(SegQueue::new());
///
/// let source = pipe!(
/// combine!(
/// interval(Duration::from_millis(100), nursery.clone()),
/// interval(Duration::from_millis(350), nursery.clone()),
/// ),
/// |s| pipe!(
/// s,
/// map(|(x, y)| format!("X{},Y{}", x, y)),
/// take(10),
/// ),
/// for_each({
/// let actual = Arc::clone(&actual);
/// move |x: String| {
/// println!("{:?}", x);
/// actual.push(x.clone());
/// }
/// }),
/// );
///
/// let nursery_out = nursery.timeout(Duration::from_millis(1_100), nursery_out);
/// drop(nursery);
/// async_std::task::block_on(nursery_out);
///
/// assert_eq!(
/// &{
/// let mut v = vec![];
/// for _i in 0..actual.len() {
/// v.push(actual.pop().unwrap());
/// }
/// v
/// }[..],
/// [
/// "X2,Y0",
/// "X3,Y0",
/// "X4,Y0",
/// "X5,Y0",
/// "X6,Y0",
/// "X6,Y1",
/// "X7,Y1",
/// "X8,Y1",
/// "X9,Y1",
/// "X9,Y2",
/// ]
/// );
/// ```
///
/// This means you can use `pipe!` to create a new operator:
///
/// ```no_run
/// use async_executors::TimerExt;
/// use async_nursery::Nursery;
/// use crossbeam_queue::SegQueue;
/// use std::{sync::Arc, time::Duration};
///
/// use callbag::{combine, for_each, interval, map, pipe, take};
///
/// let (nursery, nursery_out) = Nursery::new(async_executors::AsyncStd);
///
/// let actual = Arc::new(SegQueue::new());
///
/// let map_then_take = |f, amount| {
/// move |s| pipe!(s, map(f), take(amount))
/// };
///
/// let source = pipe!(
/// combine!(
/// interval(Duration::from_millis(100), nursery.clone()),
/// interval(Duration::from_millis(350), nursery.clone()),
/// ),
/// |s| pipe!(
/// s,
/// map_then_take(|(x, y)| format!("X{},Y{}", x, y), 10),
/// ),
/// for_each({
/// let actual = Arc::clone(&actual);
/// move |x: String| {
/// println!("{:?}", x);
/// actual.push(x.clone());
/// }
/// }),
/// );
///
/// let nursery_out = nursery.timeout(Duration::from_millis(1_100), nursery_out);
/// drop(nursery);
/// async_std::task::block_on(nursery_out);
///
/// assert_eq!(
/// &{
/// let mut v = vec![];
/// for _i in 0..actual.len() {
/// v.push(actual.pop().unwrap());
/// }
/// v
/// }[..],
/// [
/// "X2,Y0",
/// "X3,Y0",
/// "X4,Y0",
/// "X5,Y0",
/// "X6,Y0",
/// "X6,Y1",
/// "X7,Y1",
/// "X8,Y1",
/// "X9,Y1",
/// "X9,Y2",
/// ]
/// );
/// ```
///
/// [`for_each`]: crate::for_each()
/// [lodash-flow]: https://lodash.com/docs/#flow
/// [ramda-pipe]: https://ramdajs.com/docs/#pipe