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
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
use std::{
    pin::Pin,
    sync::Arc,
    task::{Context, Poll},
    time::Duration,
};

use crate::error::{RecvError, RecvTimeoutError, TryRecvError};
use futures::{task::AtomicWaker, Stream};
use std::future::Future;

use crate::{inner::Inner, util::async_recv};

// static RECV_ID: AtomicUsize = AtomicUsize::new(1);

/// The receiving half of a channel.
///
/// This struct allows receiving values both synchronously and asynchronously.
/// It can be cloned to create multiple receivers for the same channel.
///
/// # Examples
///
/// ```rust
/// use linch::bounded;
///
/// let (sender, receiver) = bounded(5);
/// sender.send(42).unwrap();
///
/// // Receive synchronously
/// let value = receiver.recv().unwrap();
/// assert_eq!(value, 42);
///
/// // Clone the receiver
/// let receiver2 = receiver.clone();
/// ```
pub struct Receiver<T> {
    pub(crate) rx: crossbeam_channel::Receiver<T>,
    inner: Arc<Inner>,
}

impl<T> Clone for Receiver<T> {
    fn clone(&self) -> Self {
        self.inner.inc_rx();

        Self {
            rx: self.rx.clone(),
            inner: self.inner.clone(),
        }
    }
}

impl<T> Drop for Receiver<T> {
    fn drop(&mut self) {
        if self.inner.dec_rx() == 1 {
            let mut signal_queues = self.inner.signal_queues();
            while let Some(waker) = signal_queues.pop_recv() {
                waker.as_ref().wake();
            }

            while let Some(waker) = signal_queues.pop_send() {
                waker.as_ref().wake();
            }
        }
    }
}

impl<T> Receiver<T> {
    /// Creates a new receiver from the underlying crossbeam channel and inner state.
    ///
    /// This is typically not called directly by users, but rather through [`channel`](crate::channel).
    pub(crate) fn new(rx: crossbeam_channel::Receiver<T>, inner: Arc<Inner>) -> Self {
        Self { rx, inner }
    }

    /// Receives a value synchronously.
    ///
    /// This method blocks until a value is available in the channel or until
    /// all senders have been dropped.
    ///
    /// # Returns
    ///
    /// * `Ok(value)` if a value was received successfully
    /// * `Err(RecvError)` if all senders have been dropped and the channel is empty
    ///
    /// # Examples
    ///
    /// ```rust
    /// use linch::bounded;
    ///
    /// let (sender, receiver) = bounded(1);
    /// sender.send(42).unwrap();
    /// assert_eq!(receiver.recv().unwrap(), 42);
    /// ```
    pub fn recv(&self) -> Result<T, RecvError> {
        let res = self.rx.recv();
        if res.is_ok() {
            self.signal_send();
        }

        Ok(res?)
    }

    /// Receives a value synchronously with a timeout.
    ///
    /// This method blocks until a value is available in the channel, the timeout
    /// expires, or all senders have been dropped.
    ///
    /// # Arguments
    ///
    /// * `timeout` - The maximum duration to wait
    ///
    /// # Returns
    ///
    /// * `Ok(value)` if a value was received successfully
    /// * `Err(RecvTimeoutError::Timeout)` if the timeout expired
    /// * `Err(RecvTimeoutError::Disconnected)` if all senders have been dropped
    ///
    /// # Examples
    ///
    /// ```rust
    /// use linch::bounded;
    /// use std::time::Duration;
    ///
    /// let (_sender, receiver) = bounded::<i32>(1);
    ///
    /// // This will timeout since no values are sent
    /// let result = receiver.recv_timeout(Duration::from_millis(10));
    /// assert!(result.is_err());
    /// ```
    pub fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError> {
        let res = self.rx.recv_timeout(timeout);
        if res.is_ok() {
            self.signal_send();
        }

        Ok(res?)
    }

    /// Attempts to receive a value without blocking.
    ///
    /// This method will either receive a value immediately if one is available
    /// in the channel, or return an error without blocking.
    ///
    /// # Returns
    ///
    /// * `Ok(value)` if a value was received successfully
    /// * `Err(TryRecvError::Empty)` if the channel is empty but not closed
    /// * `Err(TryRecvError::Disconnected)` if all senders have been dropped and the channel is empty
    ///
    /// # Examples
    ///
    /// ```rust
    /// use linch::bounded;
    /// use linch::TryRecvError;
    ///
    /// let (sender, receiver) = bounded(1);
    ///
    /// // Channel is empty
    /// match receiver.try_recv() {
    ///     Err(TryRecvError::Empty) => {}
    ///     _ => panic!("Expected Empty error"),
    /// }
    ///
    /// // After sending, we can receive
    /// sender.send(42).unwrap();
    /// assert_eq!(receiver.try_recv().unwrap(), 42);
    ///
    /// // Channel is empty again
    /// match receiver.try_recv() {
    ///     Err(TryRecvError::Empty) => {}
    ///     _ => panic!("Expected Empty error"),
    /// }
    /// ```
    pub fn try_recv(&self) -> Result<T, TryRecvError> {
        let res = self.rx.try_recv();
        if res.is_ok() {
            self.signal_send();
        }

        Ok(res?)
    }

    #[inline(always)]
    pub(crate) fn signal_send(&self) {
        if let Some(waker) = { self.inner.signal_queues().pop_send() } {
            waker.as_ref().wake();
        }
    }

    /// Receives a value asynchronously.
    ///
    /// This method returns a future that will complete when a value is available
    /// in the channel or when all senders have been dropped.
    ///
    /// # Returns
    ///
    /// A [`RecvFut`] future that resolves to:
    /// * `Ok(value)` if a value was received successfully
    /// * `Err(RecvError)` if all senders have been dropped and the channel is empty
    ///
    /// # Examples
    ///
    /// ```rust
    /// use linch::bounded;
    ///
    /// # tokio_test::block_on(async {
    /// let (sender, receiver) = bounded(1);
    /// sender.send(42).unwrap();
    /// assert_eq!(receiver.recv_async().await.unwrap(), 42);
    /// # });
    /// ```
    pub fn recv_async(&self) -> RecvFut<'_, T> {
        RecvFut {
            rx: &self.rx,
            inner: &self.inner,
            poll_cnt: 0,
            // recv_id: RECV_ID.fetch_add(2, Ordering::Release),
            waker: AtomicWaker::new(),
        }
    }

    /// Converts the receiver into a stream.
    ///
    /// This allows using the receiver with async stream utilities and for iteration.
    ///
    /// # Returns
    ///
    /// A [`RecvStream`] that yields values from the channel
    ///
    /// # Examples
    ///
    /// ```rust
    /// use linch::bounded;
    /// use futures::StreamExt;
    ///
    /// # tokio_test::block_on(async {
    /// let (sender, receiver) = bounded(3);
    /// sender.send(42).unwrap();
    /// sender.send(43).unwrap();
    /// drop(sender); // Close the channel
    ///
    /// let mut stream = receiver.into_stream();
    /// let values: Vec<_> = stream.collect().await;
    /// assert_eq!(values, vec![42, 43]);
    /// # });
    /// ```
    pub fn into_stream(self) -> RecvStream<T> {
        RecvStream {
            inner: Box::new(RecvStreamInner {
                rx: self,
                poll_cnt: 0,
                waker: AtomicWaker::new(),
            }),
        }
    }
}

/// A future representing an asynchronous receive operation.
///
/// This future is created by the [`recv_async`](Receiver::recv_async) method and will
/// complete when a value is available or when all senders have been dropped.
///
/// # Examples
///
/// ```rust
/// use linch::bounded;
///
/// # tokio_test::block_on(async {
/// let (sender, receiver) = bounded(1);
/// sender.send(42).unwrap();
/// let recv_fut = receiver.recv_async();
/// assert_eq!(recv_fut.await.unwrap(), 42);
/// # });
/// ```
pub struct RecvFut<'a, T> {
    rx: &'a crossbeam_channel::Receiver<T>,
    inner: &'a Arc<Inner>,
    poll_cnt: u32,
    waker: AtomicWaker,
}

impl<'a, T> Unpin for RecvFut<'a, T> {}

impl<'a, T> RecvFut<'a, T> {
    fn poll(
        rx: &crossbeam_channel::Receiver<T>,
        inner: &Arc<Inner>,
        poll_cnt: &mut u32,
        waker: &AtomicWaker,
        cx: &mut Context<'_>,
    ) -> Poll<Result<T, RecvError>> {
        for _ in 0..1 {
            match async_recv(rx) {
                Ok(value) => {
                    let mut signal_queues = inner.signal_queues();

                    if *poll_cnt > 0 {
                        signal_queues.remove_recv(waker as *const AtomicWaker as usize);
                    }

                    if let Some(waker_ptr) = signal_queues.pop_send() {
                        drop(signal_queues);
                        waker_ptr.as_ref().wake();
                    } else {
                        drop(signal_queues);
                    }

                    return Poll::Ready(Ok(value));
                }
                Err(TryRecvError::Empty) => {}
                Err(TryRecvError::Disconnected) => {
                    let mut signal_queues = inner.signal_queues();

                    while let Some(waker_ptr) = signal_queues.pop_send() {
                        waker_ptr.as_ref().wake();
                    }

                    while let Some(waker_ptr) = signal_queues.pop_recv() {
                        waker_ptr.as_ref().wake();
                    }

                    drop(signal_queues);
                    return Poll::Ready(Err(RecvError));
                }
            }
        }

        // if this.poll_cnt < 2 {
        //     cx.waker().wake_by_ref();
        //     return Poll::Pending;
        // }

        waker.register(cx.waker());

        let mut signal_queues = inner.signal_queues();

        match rx.try_recv() {
            Ok(value) => {
                if *poll_cnt > 0 {
                    signal_queues.remove_recv(waker as *const AtomicWaker as usize);
                }

                if let Some(waker_ptr) = signal_queues.pop_send() {
                    drop(signal_queues);
                    waker_ptr.as_ref().wake();
                }

                return Poll::Ready(Ok(value));
            }
            Err(crossbeam_channel::TryRecvError::Empty) => {}
            Err(crossbeam_channel::TryRecvError::Disconnected) => {
                while let Some(waker_ptr) = signal_queues.pop_send() {
                    waker_ptr.as_ref().wake();
                }

                while let Some(waker_ptr) = signal_queues.pop_recv() {
                    waker_ptr.as_ref().wake();
                }

                drop(signal_queues);
                return Poll::Ready(Err(RecvError));
            }
        }

        let waker_ptr = waker as *const AtomicWaker as usize;
        if *poll_cnt > 0 {
            signal_queues.remove_recv(waker_ptr);
        }
        *poll_cnt += 1;
        signal_queues.add_recv(waker_ptr);

        if let Some(waker_ptr) = signal_queues.pop_send() {
            drop(signal_queues);
            waker_ptr.as_ref().wake();
        } else {
            drop(signal_queues);
        }

        Poll::Pending
    }
}

impl<'a, T> Future for RecvFut<'a, T> {
    type Output = Result<T, RecvError>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.get_mut();

        RecvFut::poll(this.rx, this.inner, &mut this.poll_cnt, &mut this.waker, cx)
    }
}

impl<'a, T> Drop for RecvFut<'a, T> {
    fn drop(&mut self) {
        if self.poll_cnt >= 1 {
            let mut signal_queues = self.inner.signal_queues();
            signal_queues.remove_recv(&self.waker as *const AtomicWaker as usize);
        }
    }
}

pub struct RecvStreamInner<T> {
    rx: Receiver<T>,
    poll_cnt: u32,
    waker: AtomicWaker,
}

pub struct RecvStream<T> {
    inner: Box<RecvStreamInner<T>>,
}

impl<T> Unpin for RecvStream<T> {}

impl<T> Stream for RecvStream<T> {
    type Item = T;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let this = self.get_mut();

        match RecvFut::poll(
            &this.inner.rx.rx,
            &this.inner.rx.inner,
            &mut this.inner.poll_cnt,
            &this.inner.waker,
            cx,
        ) {
            Poll::Ready(Ok(item)) => {
                this.inner.poll_cnt = 0;
                // this.inner.waker.take();

                Poll::Ready(Some(item))
            }
            Poll::Ready(Err(_e)) => Poll::Ready(None),
            Poll::Pending => Poll::Pending,
        }
    }
}

impl<T> Drop for RecvStream<T> {
    fn drop(&mut self) {
        if self.inner.poll_cnt >= 1 {
            let mut signal_queues = self.inner.rx.inner.signal_queues();
            signal_queues.remove_recv(&self.inner.waker as *const AtomicWaker as usize);
        }
    }
}