circular-buffer 1.2.0

Efficient, fixed-size, overwriting circular 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
75
76

// Copyright © 2023-2025 Andrea Corbellini and contributors
// SPDX-License-Identifier: BSD-3-Clause

use circular_buffer::CircularBuffer;
use criterion::criterion_group;
use criterion::criterion_main;
use criterion::measurement::Measurement;
use criterion::BenchmarkGroup;
use criterion::Criterion;
use criterion::Throughput;

fn bench_push(c: &mut Criterion) {
    let mut group = c.benchmark_group("push");

    fn do_bench<M: Measurement, const N: usize>(
        group: &mut BenchmarkGroup<'_, M>,
        buf: &mut CircularBuffer<N, u32>,
    ) {
        group.throughput(Throughput::Elements(N as u64));
        group.bench_function("push_back", |b| {
            b.iter(|| {
                buf.push_back(1);
            })
        });
        group.bench_function("push_front", |b| {
            b.iter(|| {
                buf.push_front(1);
            })
        });
    }

    do_bench(&mut group, &mut CircularBuffer::<10, u32>::new());
    do_bench(&mut group, &mut CircularBuffer::<100, u32>::new());
    #[cfg(feature = "std")]
    do_bench(&mut group, &mut CircularBuffer::<1000, u32>::boxed());

    group.finish();
}

fn bench_pop(c: &mut Criterion) {
    let mut group = c.benchmark_group("pop");

    fn do_bench<M: Measurement, const N: usize>(
        group: &mut BenchmarkGroup<'_, M>,
        buf: &mut CircularBuffer<N, u32>,
    ) {
        buf.fill(0);
        group.throughput(Throughput::Elements(N as u64));
        group.bench_function("pop_back", |b| {
            b.iter(|| {
                let mut buf = buf.clone();
                for _ in 0..buf.capacity() {
                    buf.pop_back();
                }
            })
        });
        group.bench_function("pop_front", |b| {
            b.iter(|| {
                let mut buf = buf.clone();
                for _ in 0..buf.capacity() {
                    buf.pop_front();
                }
            })
        });
    }

    do_bench(&mut group, &mut CircularBuffer::<10, u32>::new());
    do_bench(&mut group, &mut CircularBuffer::<100, u32>::new());
    #[cfg(feature = "std")]
    do_bench(&mut group, &mut CircularBuffer::<1000, u32>::boxed());

    group.finish();
}

criterion_group!(benches, bench_push, bench_pop);
criterion_main!(benches);