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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
//! Contains the fixed `Set` implementation.
use std::vec;
use crate::{Key, Storage};
/// A fixed set implemented as a `Map` where the value is `()`.
pub struct Set<K: 'static>
where
K: Key<K, ()>,
{
storage: K::Storage,
}
/// A map implementation that uses fixed storage.
///
/// # Examples
///
/// ```rust
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut m = Set::new();
/// m.insert(Key::One);
///
/// assert_eq!(m.contains(Key::One), true);
/// assert_eq!(m.contains(Key::Two), false);
/// ```
///
/// ```rust
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Part {
/// A,
/// B,
/// }
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// Simple,
/// Composite(Part),
/// }
///
/// let mut m = Set::new();
/// m.insert(Key::Simple);
/// m.insert(Key::Composite(Part::A));
///
/// assert_eq!(m.contains(Key::Simple), true);
/// assert_eq!(m.contains(Key::Composite(Part::A)), true);
/// assert_eq!(m.contains(Key::Composite(Part::B)), false);
/// ```
impl<K: 'static> Set<K>
where
K: Key<K, ()>,
{
/// Creates an empty `Set`.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let set: Set<Key> = Set::new();
/// ```
#[inline]
pub fn new() -> Set<K> {
Set {
storage: K::Storage::default(),
}
}
/// An iterator visiting all values in arbitrary order.
/// The iterator element type is `K`.
///
/// Because of limitations in how Rust can express lifetimes through traits, this method will
/// first pre-allocate a vector to store all references.
///
/// For a zero-cost version of this function, see [`Set::iter_fn`].
///
/// [`Set::iter_fn`]: struct.Set.html#method.iter_fn
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Debug, Clone, Copy, PartialEq, Eq, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// Three,
/// }
///
/// let mut map = Set::new();
/// map.insert(Key::One);
/// map.insert(Key::Two);
///
/// assert_eq!(map.iter().collect::<Vec<_>>(), vec![Key::One, Key::Two]);
/// ```
pub fn iter(&self) -> Iter<K> {
let mut out = vec![];
self.storage.iter(|(k, _)| out.push(k));
Iter {
inner: out.into_iter(),
}
}
/// An closure visiting all values in arbitrary order.
/// The closure argument type is `K`.
///
/// This is a zero-cost version of [`Set::iter`].
///
/// [`Set::iter`]: struct.Set.html#method.iter
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Debug, Clone, Copy, PartialEq, Eq, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// Three,
/// }
///
/// let mut map = Set::new();
/// map.insert(Key::One);
/// map.insert(Key::Two);
///
/// let mut out = Vec::new();
/// map.iter_fn(|e| out.push(e));
/// assert_eq!(out, vec![Key::One, Key::Two]);
/// ```
#[inline]
pub fn iter_fn<'a, F>(&'a self, mut f: F)
where
F: FnMut(K),
{
self.storage.iter(|(k, _)| f(k))
}
/// Returns `true` if the set contains a value.
/// Returns a reference to the value corresponding to the key.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut map = Set::new();
/// map.insert(Key::One);
/// assert_eq!(map.contains(Key::One), true);
/// assert_eq!(map.contains(Key::Two), false);
/// ```
#[inline]
pub fn contains(&self, key: K) -> bool {
self.storage.get(key).is_some()
}
/// Adds a value to the set.
///
/// If the set did not have this value present, `true` is returned.
///
/// If the set did have this value present, `false` is returned.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut set = Set::new();
/// assert_eq!(set.insert(Key::One), true);
/// assert_eq!(set.is_empty(), false);
///
/// set.insert(Key::Two);
/// assert_eq!(set.insert(Key::Two), false);
/// assert_eq!(set.contains(Key::Two), true);
/// ```
#[inline]
pub fn insert(&mut self, value: K) -> bool {
self.storage.insert(value, ()).is_none()
}
/// Removes a value from the set. Returns `true` if the value was
/// present in the set.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut set = Set::new();
/// set.insert(Key::One);
/// assert_eq!(set.remove(Key::One), true);
/// assert_eq!(set.remove(Key::One), false);
/// ```
#[inline]
pub fn remove(&mut self, key: K) -> bool {
self.storage.remove(key).is_some()
}
/// Clears the set, removing all values.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut set = Set::new();
/// set.insert(Key::One);
/// set.clear();
/// assert!(set.is_empty());
/// ```
#[inline]
pub fn clear(&mut self) {
self.storage.clear()
}
/// Returns true if the set contains no elements.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut set = Set::new();
/// assert!(set.is_empty());
/// set.insert(Key::One);
/// assert!(!set.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
let mut empty = true;
self.storage.iter(|_| {
empty = false;
});
empty
}
/// Returns the number of elements in the set.
///
/// # Examples
///
/// ```
/// use fixed_map::Set;
///
/// #[derive(Clone, Copy, fixed_map::Key)]
/// enum Key {
/// One,
/// Two,
/// }
///
/// let mut set = Set::new();
/// assert_eq!(set.len(), 0);
/// set.insert(Key::One);
/// assert_eq!(set.len(), 1);
/// ```
pub fn len(&self) -> usize {
let mut len = 0;
self.storage.iter(|_| {
len += 1;
});
len
}
}
impl<K> Clone for Set<K>
where
K: Key<K, ()>,
K::Storage: Clone,
{
fn clone(&self) -> Set<K> {
Set {
storage: self.storage.clone(),
}
}
}
/// An iterator over the items of a `Set`.
///
/// This `struct` is created by the [`iter`] method on [`Set`].
/// See its documentation for more.
///
/// [`iter`]: struct.Set.html#method.iter
/// [`Set`]: struct.Set.html
#[derive(Clone)]
pub struct Iter<K> {
inner: vec::IntoIter<K>,
}
impl<K> Iterator for Iter<K> {
type Item = K;
fn next(&mut self) -> Option<Self::Item> {
self.inner.next()
}
}