circular-buffer 2.0.0

Efficient circular buffer implementation
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

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

#![allow(clippy::extra_unused_lifetimes)]

//! Tests to verify that certain types offered by the crate are [covariant].
//!
//! [covariant]: https://doc.rust-lang.org/nomicon/subtyping.html

use circular_buffer::Drain;
use circular_buffer::FixedCircularBuffer;
use circular_buffer::Iter;

/// Verify that `FixedCircularBuffer<T, N>` is covariant over `T`
#[test]
fn circular_buffer<'a>() {
    let buf = FixedCircularBuffer::<&'static str, 1>::new();
    let _: FixedCircularBuffer<&'a str, 1> = buf;
}

/// Verify that `Iter<'_, T>` is covariant over `T`
#[test]
fn iter<'a>() {
    let buf = FixedCircularBuffer::<&'static str, 1>::new();
    let iter: Iter<'_, &'static str> = buf.iter();
    let _: Iter<'_, &'a str> = iter;
}

// `IterMut<'a, T>` is invariant over `T` because it holds a mutable reference to the elements of
// the buffer.
//
// TODO Add a test to verify the invariance of `IterMut`
//
//#[test]
//fn iter_mut<'a>() {
//    let mut buf = FixedCircularBuffer::<&'static str, 1>::new();
//    let iter: IterMut<'_, &'static str> = buf.iter_mut();
//    let _: IterMut<'_, &'a str> = iter;
//}

/// Verify that `Drain<'_, T>` is covariant over `T`
#[test]
fn drain<'a>() {
    let mut buf = FixedCircularBuffer::<&'static str, 1>::new();
    let drain: Drain<'_, &'static str> = buf.drain(..);
    let _: Drain<'_, &'a str> = drain;
}