lochan 0.1.0

Single-threaded (!Send), no_std, no-atomics async channels for thread-per-core runtimes: mpsc and oneshot, with non-blocking (try_*) and awaitable APIs.
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

use super::*;

use core::cell::Cell;
use std::rc::Rc;

#[test]
fn push_pop_is_fifo() {
  let mut ring = Ring::with_capacity(3);
  ring.push(1).unwrap();
  ring.push(2).unwrap();
  assert_eq!(ring.pop(), Some(1));
  assert_eq!(ring.pop(), Some(2));
  assert_eq!(ring.pop(), None);
}

#[test]
fn push_reports_full_at_capacity() {
  let mut ring = Ring::with_capacity(2);
  ring.push(1).unwrap();
  ring.push(2).unwrap();
  assert_eq!(ring.push(3), Err(3));
}

#[test]
fn wraps_around_the_buffer() {
  let mut ring = Ring::with_capacity(2);
  ring.push(1).unwrap();
  ring.push(2).unwrap();
  assert_eq!(ring.pop(), Some(1)); // head advances to slot 1
  ring.push(3).unwrap(); // tail wraps to slot 0
  assert_eq!(ring.pop(), Some(2));
  assert_eq!(ring.pop(), Some(3));
  assert_eq!(ring.pop(), None);
}

#[derive(Debug)]
struct DropCounter(Rc<Cell<usize>>);

impl Drop for DropCounter {
  fn drop(&mut self) {
    self.0.set(self.0.get() + 1);
  }
}

#[test]
fn drop_releases_queued_items() {
  let count = Rc::new(Cell::new(0));
  {
    let mut ring = Ring::with_capacity(4);
    ring.push(DropCounter(count.clone())).unwrap();
    ring.push(DropCounter(count.clone())).unwrap();
    assert_eq!(count.get(), 0);
  }
  // The ring's Drop must drop both still-queued items exactly once.
  assert_eq!(count.get(), 2);
}

#[test]
fn pop_then_drop_does_not_double_drop() {
  let count = Rc::new(Cell::new(0));
  let mut ring = Ring::with_capacity(4);
  ring.push(DropCounter(count.clone())).unwrap();
  ring.push(DropCounter(count.clone())).unwrap();
  drop(ring.pop()); // drops one
  assert_eq!(count.get(), 1);
  drop(ring); // drops the remaining one — not the already-popped slot
  assert_eq!(count.get(), 2);
}