rtrb 0.3.4

A realtime-safe single-producer single-consumer ring buffer
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

#![cfg(feature = "std")]

use std::io::{Read, Write};

use rtrb::RingBuffer;

#[test]
fn write_and_read() {
    let (mut p, mut c) = RingBuffer::new(2);
    assert_eq!(p.write(&[10, 11]).unwrap(), 2);
    // Does nothing:
    assert!(p.flush().is_ok());

    {
        let mut buf = [0];
        assert_eq!(c.read(&mut buf).unwrap(), 1);
        assert_eq!(buf, [10]);
    }

    assert_eq!(p.write(&[12, 99]).unwrap(), 1);

    {
        let mut buf = [0, 0];
        assert_eq!(c.read(&mut buf).unwrap(), 2);
        assert_eq!(buf, [11, 12]);
    }

    assert_eq!(p.write(&[13, 14]).unwrap(), 2);

    {
        let mut buf = [0];
        assert_eq!(c.read(&mut buf).unwrap(), 1);
        assert_eq!(buf, [13]);
    }

    {
        let mut buf = [20, 21];
        assert_eq!(c.read(&mut buf).unwrap(), 1);
        assert_eq!(buf, [14, 21]);
    }
}

#[test]
fn write_empty_buf() {
    let (mut p, _c) = RingBuffer::new(2);
    assert_eq!(p.write(&[]).unwrap(), 0);
}

#[test]
fn read_empty_buf() {
    let (mut p, mut c) = RingBuffer::new(2);
    assert_eq!(p.push(99), Ok(()));
    assert_eq!(c.read(&mut []).unwrap(), 0);
}

#[test]
fn write_error() {
    let (mut p, _c) = RingBuffer::new(1);
    assert_eq!(p.push(10), Ok(()));
    assert_eq!(
        p.write(&[99]).unwrap_err().kind(),
        std::io::ErrorKind::WouldBlock
    );
}

#[test]
fn read_error() {
    let (_p, mut c) = RingBuffer::new(1);
    let mut buf = [0];
    assert_eq!(
        c.read(&mut buf).unwrap_err().kind(),
        std::io::ErrorKind::WouldBlock
    );
}