embassy-sync 0.8.0

no-std, no-alloc synchronization primitives with async support
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

use core::ops::Range;

#[derive(Debug)]
pub struct RingBuffer<const N: usize> {
    start: usize,
    end: usize,
    full: bool,
}

impl<const N: usize> RingBuffer<N> {
    pub const fn new() -> Self {
        Self {
            start: 0,
            end: 0,
            full: false,
        }
    }

    pub fn push_buf(&mut self) -> Range<usize> {
        if self.is_full() {
            trace!("  ringbuf: push_buf full");
            return 0..0;
        }

        let n = if self.start <= self.end {
            N - self.end
        } else {
            self.start - self.end
        };

        trace!("  ringbuf: push_buf {:?}..{:?}", self.end, self.end + n);
        self.end..self.end + n
    }

    pub fn push(&mut self, n: usize) {
        trace!("  ringbuf: push {:?}", n);
        if n == 0 {
            return;
        }

        self.end = self.wrap(self.end + n);
        self.full = self.start == self.end;
    }

    pub fn pop_buf(&mut self) -> Range<usize> {
        if self.is_empty() {
            trace!("  ringbuf: pop_buf empty");
            return 0..0;
        }

        let n = if self.end <= self.start {
            N - self.start
        } else {
            self.end - self.start
        };

        trace!("  ringbuf: pop_buf {:?}..{:?}", self.start, self.start + n);
        self.start..self.start + n
    }

    pub fn pop(&mut self, n: usize) {
        trace!("  ringbuf: pop {:?}", n);
        if n == 0 {
            return;
        }

        self.start = self.wrap(self.start + n);
        self.full = false;
    }

    pub fn is_full(&self) -> bool {
        self.full
    }

    pub fn is_empty(&self) -> bool {
        self.start == self.end && !self.full
    }

    #[allow(unused)]
    pub fn len(&self) -> usize {
        if self.is_empty() {
            0
        } else if self.start < self.end {
            self.end - self.start
        } else {
            N + self.end - self.start
        }
    }

    pub fn clear(&mut self) {
        self.start = 0;
        self.end = 0;
        self.full = false;
    }

    fn wrap(&self, n: usize) -> usize {
        assert!(n <= N);
        if n == N { 0 } else { n }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn push_pop() {
        let mut rb: RingBuffer<4> = RingBuffer::new();
        let buf = rb.push_buf();
        assert_eq!(0..4, buf);
        rb.push(4);

        let buf = rb.pop_buf();
        assert_eq!(0..4, buf);
        rb.pop(1);

        let buf = rb.pop_buf();
        assert_eq!(1..4, buf);
        rb.pop(1);

        let buf = rb.pop_buf();
        assert_eq!(2..4, buf);
        rb.pop(1);

        let buf = rb.pop_buf();
        assert_eq!(3..4, buf);
        rb.pop(1);

        let buf = rb.pop_buf();
        assert_eq!(0..0, buf);

        let buf = rb.push_buf();
        assert_eq!(0..4, buf);
    }
}