cl-traits 4.1.0

Provides traits that describe collections
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

//! Instances for documentation tests

use crate::ArrayWrapper;
#[cfg(all(feature = "alloc", not(feature = "std")))]
use alloc::vec::Vec;

/// `ArrayWrapper` with three elements
pub fn array_wrapper() -> ArrayWrapper<[i32; 3]> {
  ArrayWrapper::new([1, 2, 3])
}

/// Slice with three elements
pub fn slice() -> &'static [i32] {
  &[1, 2, 3]
}

#[cfg(feature = "alloc")]
/// `Vec` with three elements
pub fn vec() -> Vec<i32> {
  let mut vec = Vec::with_capacity(5);
  vec.extend([1, 2, 3].iter().copied());
  vec
}

#[cfg(feature = "with-arrayvec")]
/// `ArrayVec` with three elements
pub fn array_vec() -> arrayvec::ArrayVec<ArrayWrapper<[i32; 5]>> {
  let mut vec = arrayvec::ArrayVec::new();
  vec.extend([1, 2, 3].iter().copied());
  vec
}

#[cfg(feature = "with-smallvec")]
/// `SmallVec` with three elements
pub fn small_vec() -> smallvec::SmallVec<ArrayWrapper<[i32; 5]>> {
  let mut vec = smallvec::SmallVec::new();
  vec.extend([1, 2, 3].iter().copied());
  vec
}

#[cfg(feature = "with-staticvec")]
/// `StaticVec` with three elements
pub fn static_vec() -> staticvec::StaticVec<i32, 5> {
  let mut vec = staticvec::StaticVec::new();
  vec.extend([1, 2, 3].iter().copied());
  vec
}

#[cfg(feature = "with-tinyvec")]
/// `tinyvec::ArrayVec` with three elements
pub fn tiny_vec_array_vec() -> tinyvec::ArrayVec<ArrayWrapper<[i32; 5]>> {
  let mut vec = tinyvec::ArrayVec::new();
  vec.extend([1, 2, 3].iter().copied());
  vec
}

#[cfg(all(feature = "alloc", feature = "with-tinyvec"))]
/// `TinyVec` with three elements
pub fn tiny_vec() -> tinyvec::TinyVec<ArrayWrapper<[i32; 5]>> {
  let mut vec = tinyvec::TinyVec::new();
  vec.extend([1, 2, 3].iter().copied());
  vec
}