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
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

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

/// See [`length`](Length::length) for more information.
pub trait Length {
  /// Output
  type Output;

  /// Holds a certain number of elements.
  fn length(&self) -> Self::Output;
}

/// ```rust
/// let mut opt = Some(0);
/// assert_eq!(cl_traits::Length::length(&opt), 1);
/// opt.take();
/// assert_eq!(cl_traits::Length::length(&opt), 0);
/// ```
impl<T> Length for Option<T> {
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    if self.is_some() {
      1
    } else {
      0
    }
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::slice();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
impl<'a, T> Length for &'a [T] {
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// assert_eq!(cl_traits::Length::length(&&mut [1, 2, 3][..]), 3);
/// ```
impl<'a, T> Length for &'a mut [T] {
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::array_wrapper();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
impl<A> Length for ArrayWrapper<A>
where
  A: Array,
{
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.array.slice().len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::vec();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
#[cfg(feature = "alloc")]
impl<T> Length for Vec<T> {
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::array_vec();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
#[cfg(feature = "with-arrayvec")]
impl<A> Length for arrayvec::ArrayVec<A>
where
  A: arrayvec::Array,
{
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::small_vec();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
#[cfg(feature = "with-smallvec")]
impl<A> Length for smallvec::SmallVec<A>
where
  A: smallvec::Array,
{
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::static_vec();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
#[cfg(feature = "with-staticvec")]
impl<T, const N: usize> Length for staticvec::StaticVec<T, N> {
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::tiny_vec_array_vec();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
#[cfg(feature = "with-tinyvec")]
impl<A> Length for tinyvec::ArrayVec<A>
where
  A: tinyvec::Array,
  A::Item: Default,
{
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}

/// ```rust
/// let structure = cl_traits::doc_tests::tiny_vec();
/// assert_eq!(cl_traits::Length::length(&structure), 3);
/// ```
#[cfg(all(feature = "alloc", feature = "with-tinyvec"))]
impl<A> Length for tinyvec::TinyVec<A>
where
  A: tinyvec::Array,
  A::Item: Default,
{
  type Output = usize;

  #[inline]
  fn length(&self) -> Self::Output {
    self.len()
  }
}