cl-aux 5.1.0

Provides elements 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
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

use crate::SingleItemStorage;
#[cfg(feature = "alloc")]
use alloc::{string::String, vec::Vec};

/// See [`Capacity::capacity`] for more information.
pub trait Capacity {
  /// The number of elements the implementation has pre-allocated as an internal buffer. Not
  /// necessarily the current number of inserted elements.
  fn capacity(&self) -> usize;
}

impl<T> Capacity for &T
where
  T: Capacity,
{
  #[inline]
  fn capacity(&self) -> usize {
    (*self).capacity()
  }
}

/// ```rust
/// assert_eq!(cl_aux::Capacity::capacity(&()), 0);
/// ```
impl Capacity for () {
  #[inline]
  fn capacity(&self) -> usize {
    0
  }
}

/// ```rust
/// assert_eq!(cl_aux::Capacity::capacity(&Some(0)), 1);
/// ```
impl<T> Capacity for Option<T> {
  #[inline]
  fn capacity(&self) -> usize {
    1
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::single_item_storage();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 1);
/// ```
impl<T> Capacity for SingleItemStorage<T> {
  #[inline]
  fn capacity(&self) -> usize {
    1
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::array();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 3);
/// ```
impl<T, const N: usize> Capacity for [T; N] {
  #[inline]
  fn capacity(&self) -> usize {
    N
  }
}

/// ```rust
/// let structure = cl_aux::doc_tests::slice();
/// assert_eq!(cl_aux::Length::length(&structure), 3);
/// ```
impl<T> Capacity for &'_ [T] {
  #[inline]
  fn capacity(&self) -> usize {
    self.len()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::slice_mut!();
/// assert_eq!(cl_aux::Length::length(&mut structure), 3);
/// ```
impl<T> Capacity for &'_ mut [T] {
  #[inline]
  fn capacity(&self) -> usize {
    self.len()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::string();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 5);
/// ```
#[cfg(feature = "alloc")]
impl Capacity for String {
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::vec();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 5);
/// ```
#[cfg(feature = "alloc")]
impl<T> Capacity for Vec<T> {
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::array_string();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 10);
/// ```
#[cfg(feature = "arrayvec")]
impl<const N: usize> Capacity for arrayvec::ArrayString<N> {
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::array_vec();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 5);
/// ```
#[cfg(feature = "arrayvec")]
impl<T, const N: usize> Capacity for arrayvec::ArrayVec<T, N> {
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::small_vec();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 5);
/// ```
#[cfg(feature = "smallvec")]
impl<A> Capacity for smallvec::SmallVec<A>
where
  A: smallvec::Array,
{
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::tiny_vec_array_vec();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 5);
/// ```
#[cfg(feature = "tinyvec")]
impl<A> Capacity for tinyvec::ArrayVec<A>
where
  A: tinyvec::Array,
  A::Item: Default,
{
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::tiny_vec_tiny_vec();
/// assert_eq!(cl_aux::Capacity::capacity(&structure), 5);
/// ```
#[cfg(all(feature = "alloc", feature = "tinyvec"))]
impl<A> Capacity for tinyvec::TinyVec<A>
where
  A: tinyvec::Array,
  A::Item: Default,
{
  #[inline]
  fn capacity(&self) -> usize {
    self.capacity()
  }
}