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
use std::collections::{HashMap, hash_map::{Keys, Values}};
use std::hash::Hash;
/// This struct mimicks the behaviour of a python defaultdict. This means alongside the traitbounds
/// that apply on the key and value that are inherited from the [`HashMap`], it also requires the
/// [`Default`] trait be implemented on the value type.
pub struct DefaultHashMap<K, V>
where
K: Eq + Hash,
V: Default,
{
_inner: HashMap<K, V>
}
impl<K: Eq + Hash, V: Default> DefaultHashMap<K, V> {
/// Creates an empty [`DefaultHashMap`].
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let map = DefaultHashMap::<i8, i8>::new();
/// ```
#[must_use]
pub fn new() -> Self {
Self {
_inner: HashMap::new()
}
}
/// Inserts a key value pair into the map.
///
/// If the map had the key already present it will be overwritten.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20)
/// ```
#[inline]
pub fn insert(&mut self, key: K, value: V)
where
K: Eq + Hash
{
let _ = &self._inner.insert(key, value);
}
/// Returns a reference to the value of the key passed in.
/// Because this hashmap mimicks the python defaultdict, it will also return a reference to a
/// value if the key is not present. This reference will then be stored in the hashmap and be
/// the default value.
///
/// The key type must implement Hash and Eq.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20);
///
/// println!("{}", map.get(&10));
/// ```
#[must_use]
pub fn get(&mut self, key: &K) -> &V
where
K: Sized + Eq + Hash + Clone
{
#[allow(unused_assignments)]
let mut rv: Option<&V> = Option::None;
let mut check: bool = false;
for _key in self._inner.keys() {
if key == _key {
check = true;
}
}
match check {
true => {
rv = self._inner.get(&key);
},
false => {
self.insert(key.clone(), V::default());
rv = self._inner.get(&key);
},
};
rv.unwrap()
}
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// let number = map.get_mut(&10);
///
/// *number = 100;
///
/// println!("{}", map.get(&10));
/// ```
#[must_use]
pub fn get_mut(&mut self, key: &K) -> &mut V
where
K: Sized + Hash + Eq + Clone
{
#[allow(unused_assignments)]
let mut rv: Option<&mut V> = Option::None;
let mut check: bool = false;
for _key in self._inner.keys() {
if key == _key {
check = true;
}
}
match check {
true => {
rv = self._inner.get_mut(&key);
},
false => {
self.insert(key.clone(), V::default());
rv = self._inner.get_mut(&key);
},
};
rv.unwrap()
}
/// Removes a key from the map, returning the value at the key if the key was previously in the
/// map. If the key is not present in the map it will return the default value.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20);
///
/// println!("{}", map.remove(&10));
///
/// println!("{}", map.remove(&90));
/// ```
#[must_use]
pub fn remove(&mut self, key: &K) -> V
where
K: Hash + Eq
{
match self._inner.remove(key) {
Some(value) => value,
None => V::default()
}
}
/// Returns an iterator visiting all keys in arbitrary order. The iterator element type is &'a K.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20);
/// map.insert(11, 21);
/// map.insert(12, 22);
/// map.insert(13, 23);
///
/// println!("{:?}", map.keys());
/// ```
#[inline]
pub fn keys(&self) -> Keys<'_, K, V> {
self._inner.keys()
}
/// Returns an iterator visiting all values in arbitrary order. The iterator element type is
/// &'a V.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20);
/// map.insert(11, 21);
/// map.insert(12, 22);
/// map.insert(13, 23);
///
/// println!("{:?}", map.values());
/// ```
#[inline]
pub fn values(&self) -> Values<'_, K, V> {
self._inner.values()
}
/// Returns the length of the keys in the map.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20);
/// map.insert(11, 21);
/// map.insert(12, 22);
/// map.insert(13, 23);
///
/// println!("{}", map.len());
/// ```
#[inline]
pub fn len(&self) -> usize {
self._inner.len()
}
/// Returns true if the key passed in exists in the HashMap.
///
/// # Example
/// ```
/// use defaultdict::DefaultHashMap;
///
/// let mut map = DefaultHashMap::<i8, i8>::new();
/// map.insert(10, 20);
///
/// println!("{}", map.contains_key(&10));
/// ```
#[inline]
pub fn contains_key(&self, key: &K) -> bool
where
K: Eq + Hash
{
self._inner.contains_key(key)
}
}