devela/data/
collection.rs

Help
1// devela::data::collection
2//
3//! Defines the [`DataCollection`] abstract data type.
4//
5// TOC
6// - define DataCollection
7// - impl for devela types:
8//   - Array
9// - impl for reexported types:
10//   - array
11//   - Vec
12//   - VecDeque
13//   - PriorityQueue
14//   - OrderedMap
15//   - OrderedSet
16//   - UnorderedMap
17//   - UnorderedSet
18
19use crate::{
20    Array,
21    NotAvailable::{self, NotImplemented, NotSupported},
22    Storage,
23};
24#[cfg(feature = "alloc")]
25use crate::{BTreeMap, BTreeSet, BinaryHeap, Vec, VecDeque};
26#[cfg(all(feature = "alloc", feature = "dep_hashbrown"))]
27use crate::{HashMap, HashSet};
28
29type Result<T> = crate::Result<T, NotAvailable>;
30
31#[doc = crate::TAG_DATA_STRUCTURE!()]
32/// An abstract *collection* data type.
33///
34/// By default returns [`NotImplemented`] for every method.
35#[rustfmt::skip] #[allow(unused_variables)]
36pub trait DataCollection {
37    /// The element type of the collection.
38    type Element;
39
40    /// Returns the reserved capacity for elements in the collection.
41    fn collection_capacity(&self) -> Result<usize> { Err(NotImplemented) }
42    /// Returns the current number of elements in the collection.
43    fn collection_len(&self) -> Result<usize> { Err(NotImplemented) }
44
45    /// Returns `true` if the collection is empty, `false` if it's not.
46    fn collection_is_empty(&self) -> Result<bool> { Err(NotImplemented) }
47    /// Returns `true` if the collection is full, `false` if it's not.
48    fn collection_is_full(&self) -> Result<bool> { Err(NotImplemented) }
49
50    /// Returns `true` if the collection contains the given `element`.
51    fn collection_contains(&self, element: Self::Element) -> Result<bool>
52    where Self::Element: PartialEq { Err(NotImplemented) }
53    /// Counts the number of times a given `element` appears in the collection.
54    fn collection_count(&self, element: &Self::Element) -> Result<usize>
55    where Self::Element: PartialEq { Err(NotImplemented) }
56}
57
58/* impl for devela types */
59
60#[rustfmt::skip]
61impl<T, const LEN: usize, S: Storage> DataCollection for Array<T, LEN, S> {
62    type Element = T;
63    /// The capacity of a fixed-size array is always equal to its length.
64    fn collection_capacity(&self) -> Result<usize> { Ok(LEN) }
65    fn collection_len(&self) -> Result<usize> { Ok(LEN) }
66    /// Returns [`NotSupported`] since a fixed-size array is never empty or full.
67    fn collection_is_empty(&self) -> Result<bool> { Err(NotSupported) }
68    /// Returns [`NotSupported`] since a fixed-size array is never empty or full.
69    fn collection_is_full(&self) -> Result<bool> { Err(NotSupported) }
70    fn collection_contains(&self, element: Self::Element) -> Result<bool> where T: PartialEq {
71        Ok(self.contains(&element))
72    }
73    fn collection_count(&self, element: &Self::Element) -> Result<usize> where T: PartialEq {
74        Ok(self.iter().filter(|&e| e == element).count())
75    }
76}
77
78/* impl for reexported types */
79
80// array
81#[rustfmt::skip]
82impl<T, const N: usize> DataCollection for [T; N] {
83    type Element = T;
84    // For a fixed-size array, the capacity is always the length of the array.
85    fn collection_capacity(&self) -> Result<usize> { Ok(N) }
86    fn collection_len(&self) -> Result<usize> { Ok(N) }
87    // A fixed-size array is never empty nor full.
88    /// Returns [`NotSupported`] since a fixed-size array is never empty or full.
89    fn collection_is_empty(&self) -> Result<bool> { Err(NotSupported) }
90    /// Returns [`NotSupported`] since a fixed-size array is never empty or full.
91    fn collection_is_full(&self) -> Result<bool> { Err(NotSupported) }
92
93    fn collection_contains(&self, element: Self::Element) -> Result<bool> where T: PartialEq {
94        Ok(self.contains(&element))
95    }
96    fn collection_count(&self, element: &Self::Element) -> Result<usize> where T: PartialEq {
97        Ok(self.iter().filter(|&e| e == element).count())
98    }
99}
100
101#[rustfmt::skip]
102#[cfg(feature = "alloc")]
103impl<T> DataCollection for Vec<T> {
104    type Element = T;
105    fn collection_capacity(&self) -> Result<usize> { Ok(self.capacity()) }
106    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
107    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
108    fn collection_is_full(&self) -> Result<bool> { Ok(self.len() >= self.capacity()) }
109    fn collection_contains(&self, element: Self::Element) -> Result<bool> where T: PartialEq {
110        Ok(self.contains(&element))
111    }
112    fn collection_count(&self, element: &Self::Element) -> Result<usize> where T: PartialEq {
113        Ok(self.iter().filter(|&e| e == element).count())
114    }
115}
116
117#[rustfmt::skip]
118#[cfg(feature = "alloc")]
119impl<T> DataCollection for VecDeque<T> {
120    type Element = T;
121    fn collection_capacity(&self) -> Result<usize> { Ok(self.capacity()) }
122    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
123    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
124    fn collection_is_full(&self) -> Result<bool> { Ok(self.len() >= self.capacity()) }
125    fn collection_contains(&self, element: Self::Element) -> Result<bool> where T: PartialEq {
126        Ok(self.contains(&element))
127    }
128    fn collection_count(&self, element: &Self::Element) -> Result<usize> where T: PartialEq {
129        Ok(self.iter().filter(|&e| e == element).count())
130    }
131}
132
133#[rustfmt::skip]
134#[cfg(feature = "alloc")]
135impl<T> DataCollection for BinaryHeap<T> {
136    type Element = T;
137    fn collection_capacity(&self) -> Result<usize> { Ok(self.capacity()) }
138    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
139    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
140    fn collection_is_full(&self) -> Result<bool> { Ok(self.len() >= self.capacity()) }
141    /// Returns [`NotSupported`].
142    fn collection_contains(&self, _: Self::Element) -> Result<bool> { Err(NotSupported) }
143    /// Returns [`NotSupported`].
144    fn collection_count(&self, _: &Self::Element) -> Result<usize> { Err(NotSupported) }
145}
146
147#[rustfmt::skip]
148#[cfg(feature = "alloc")]
149impl<K, V> DataCollection for BTreeMap<K, V> {
150    type Element = V;
151    /// Returns [`NotSupported`].
152    fn collection_capacity(&self) -> Result<usize> { Err(NotSupported) }
153    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
154    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
155    /// Returns [`NotSupported`].
156    fn collection_is_full(&self) -> Result<bool> { Err(NotSupported) }
157    fn collection_contains(&self, element: Self::Element) -> Result<bool> where V: PartialEq {
158        Ok(self.values().any(|value| *value == element))
159    }
160    fn collection_count(&self, element: &Self::Element) -> Result<usize> where V: PartialEq {
161        Ok(self.values().filter(|&value| value == element).count())
162    }
163}
164#[rustfmt::skip]
165#[cfg(feature = "alloc")]
166impl<V> DataCollection for BTreeSet<V> {
167    type Element = V;
168    /// Returns [`NotSupported`].
169    fn collection_capacity(&self) -> Result<usize> { Err(NotSupported) }
170    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
171    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
172    /// Returns [`NotSupported`].
173    fn collection_is_full(&self) -> Result<bool> { Err(NotSupported) }
174    /// This is less efficent than [`BTreeSet::contains`] for not having [`Ord`].
175    fn collection_contains(&self, element: Self::Element) -> Result<bool> where V: PartialEq {
176        Ok(self.iter().any(|value| *value == element))
177    }
178    /// This is less efficent than [`BTreeSet::contains`] for not having [`Ord`].
179    fn collection_count(&self, element: &Self::Element) -> Result<usize> where V: PartialEq {
180        Ok(usize::from(self.iter().any(|e| e == element)))
181    }
182}
183
184#[rustfmt::skip]
185#[cfg(all(feature = "alloc", feature = "dep_hashbrown"))]
186impl<K, V> DataCollection for HashMap<K, V> {
187    type Element = V;
188    /// Returns [`NotSupported`].
189    fn collection_capacity(&self) -> Result<usize> { Err(NotSupported) }
190    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
191    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
192    /// Returns [`NotSupported`].
193    fn collection_is_full(&self) -> Result<bool> { Err(NotSupported) }
194    fn collection_contains(&self, element: Self::Element) -> Result<bool> where V: PartialEq {
195        Ok(self.values().any(|value| *value == element))
196    }
197    fn collection_count(&self, element: &Self::Element) -> Result<usize> where V: PartialEq {
198        Ok(self.values().filter(|&value| value == element).count())
199    }
200}
201#[rustfmt::skip]
202#[cfg(all(feature = "alloc", feature = "dep_hashbrown"))]
203impl<V> DataCollection for HashSet<V> {
204    type Element = V;
205    fn collection_capacity(&self) -> Result<usize> { Ok(self.capacity()) }
206    fn collection_len(&self) -> Result<usize> { Ok(self.len()) }
207    fn collection_is_empty(&self) -> Result<bool> { Ok(self.is_empty()) }
208    fn collection_is_full(&self) -> Result<bool> { Err(NotSupported) }
209    /// This is less efficent than [`HashSet::contains`] for not having [`Hash`] and [`Eq`].
210    fn collection_contains(&self, element: Self::Element) -> Result<bool> where V: PartialEq {
211        Ok(self.iter().any(|value| *value == element))
212    }
213    /// This is less efficent than [`HashSet::contains`] for not having [`Hash`] and [`Eq`].
214    fn collection_count(&self, element: &Self::Element) -> Result<usize> where V: PartialEq {
215        Ok(usize::from(self.iter().any(|e| e == element)))
216    }
217}
devela/data/collection.rs

devela/data/
collection.rs
