cairo_lang_utils/
ordered_hash_set.rs

1use core::hash::{BuildHasher, Hash};
2use core::ops::Sub;
3#[cfg(feature = "std")]
4use std::collections::hash_map::RandomState;
5
6use indexmap::IndexSet;
7use itertools::zip_eq;
8
9#[cfg(feature = "std")]
10#[derive(Clone, Debug)]
11pub struct OrderedHashSet<Key, BH = RandomState>(IndexSet<Key, BH>);
12#[cfg(not(feature = "std"))]
13#[derive(Clone, Debug)]
14pub struct OrderedHashSet<Key, BH = hashbrown::DefaultHashBuilder>(IndexSet<Key, BH>);
15
16impl<Key, BH> core::ops::Deref for OrderedHashSet<Key, BH> {
17    type Target = IndexSet<Key, BH>;
18
19    fn deref(&self) -> &Self::Target {
20        &self.0
21    }
22}
23
24impl<Key, BH> core::ops::DerefMut for OrderedHashSet<Key, BH> {
25    fn deref_mut(&mut self) -> &mut Self::Target {
26        &mut self.0
27    }
28}
29
30// This code was taken from the salsa::Update trait implementation for IndexSet.
31// It is defined privately in macro_rules! maybe_update_set in the db-ext-macro repo.
32#[cfg(feature = "salsa")]
33unsafe impl<Key: Eq + Hash, BH: BuildHasher> salsa::Update for OrderedHashSet<Key, BH> {
34    unsafe fn maybe_update(old_pointer: *mut Self, new_set: Self) -> bool {
35        let old_set: &mut Self = unsafe { &mut *old_pointer };
36
37        if *old_set == new_set {
38            false
39        } else {
40            old_set.clear();
41            old_set.extend(new_set);
42            true
43        }
44    }
45}
46
47pub type Iter<'a, Key> = indexmap::set::Iter<'a, Key>;
48
49impl<Key, BH: Default> Default for OrderedHashSet<Key, BH> {
50    #[cfg(feature = "std")]
51    fn default() -> Self {
52        Self(Default::default())
53    }
54    #[cfg(not(feature = "std"))]
55    fn default() -> Self {
56        Self(IndexSet::with_hasher(Default::default()))
57    }
58}
59
60impl<Key, BH> IntoIterator for OrderedHashSet<Key, BH> {
61    type Item = Key;
62    type IntoIter = <IndexSet<Key, BH> as IntoIterator>::IntoIter;
63
64    fn into_iter(self) -> Self::IntoIter {
65        self.0.into_iter()
66    }
67}
68
69impl<'a, Key, BH> IntoIterator for &'a OrderedHashSet<Key, BH> {
70    type Item = &'a Key;
71    type IntoIter = <&'a IndexSet<Key, BH> as IntoIterator>::IntoIter;
72
73    fn into_iter(self) -> Self::IntoIter {
74        self.iter()
75    }
76}
77
78impl<Key: Eq, BH> PartialEq for OrderedHashSet<Key, BH> {
79    fn eq(&self, other: &Self) -> bool {
80        if self.len() != other.len() {
81            return false;
82        };
83
84        zip_eq(self.iter(), other.iter()).all(|(a, b)| a == b)
85    }
86}
87
88impl<Key: Eq, BH> Eq for OrderedHashSet<Key, BH> {}
89
90impl<Key: Hash + Eq, BH: BuildHasher + Default> FromIterator<Key> for OrderedHashSet<Key, BH> {
91    fn from_iter<T: IntoIterator<Item = Key>>(iter: T) -> Self {
92        Self(iter.into_iter().collect())
93    }
94}
95
96impl<'a, Key, BH> Sub<&'a OrderedHashSet<Key, BH>> for &'a OrderedHashSet<Key, BH>
97where
98    &'a IndexSet<Key, BH>: Sub<Output = IndexSet<Key, BH>>,
99{
100    type Output = OrderedHashSet<Key, BH>;
101
102    fn sub(self, rhs: Self) -> Self::Output {
103        OrderedHashSet::<Key, BH>(&self.0 - &rhs.0)
104    }
105}
106
107#[cfg(feature = "serde")]
108mod impl_serde {
109    use serde::{Deserialize, Deserializer, Serialize, Serializer};
110
111    use super::*;
112
113    impl<K: Hash + Eq + Serialize, BH: BuildHasher> Serialize for OrderedHashSet<K, BH> {
114        fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
115            self.0.serialize(serializer)
116        }
117    }
118
119    impl<'de, K: Hash + Eq + Deserialize<'de>, BH: BuildHasher + Default> Deserialize<'de>
120        for OrderedHashSet<K, BH>
121    {
122        fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
123            IndexSet::<K, BH>::deserialize(deserializer).map(|s| OrderedHashSet(s))
124        }
125    }
126}
cairo_lang_utils/ordered_hash_set.rs

cairo_lang_utils/
ordered_hash_set.rs
