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 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
// Copyright 2019 Octavian Oncescu //! # HashCow //! //! HashCow is a HashMap implementation with copy-on-write keys and values. //! //! --- //! //! Originally built for optimizing the [Purple Protocol](https://github.com/purpleprotocol/purple), this library provides a way to link HashMaps in memory that have duplicate entries. Instead of the duplicate data, it is instead borrowed and it is only cloned when mutation is needed. //! //! ### Using HashCow //! ```rust //! use hashcow::{Form, CowHashMap}; //! //! let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); //! //! // We insert an owned value in the map //! hm.insert_owned("key".to_owned(), vec![1, 2, 3]); //! assert_eq!(hm.entry_form(&"key").unwrap(), Form::Owned); //! //! // We now create a clone with borrowed fields //! let mut hm_clone = hm.borrow_fields(); //! assert_eq!(hm_clone.entry_form(&"key").unwrap(), Form::Borrowed); //! //! // On mutation, the borrowed entry is cloned //! let entry = hm_clone.get_mut(&"key").unwrap(); //! //!// We now mutate the cloned value //! *entry = vec![4, 5, 6]; //! assert_eq!(hm_clone.entry_form(&"key").unwrap(), Form::Owned); //! //! // The two maps now have different entries for the same key //! assert_eq!(hm.get(&"key").unwrap(), &[1, 2, 3]); //! assert_eq!(hm_clone.get(&"key").unwrap(), &[4, 5, 6]); //! ``` //! //! ### Contributing //! We welcome anyone wishing to contribute to HashCow! Check out the [issues section][issues] of the repository before starting out. //! //! ### License //! //! HashCow is licensed under the MIT license. use hashbrown::HashMap; use std::borrow::{Borrow, Cow, ToOwned}; use std::hash::Hash; #[derive(Clone, Copy, Debug, PartialEq)] /// The form of the entry in the map. Can be either /// `Borrowed` or `Owned`. pub enum Form { /// The map entry is borrowed. Borrowed, /// The map entry is owned. Owned, } /// A HashMap data-structure with copy-on-write keys and values. pub struct CowHashMap<'a, K, V> where K: Hash + ?Sized + PartialEq + Eq + ToOwned, V: ToOwned + ?Sized, { inner: HashMap<Cow<'a, K>, Cow<'a, V>> } impl<'a, K, V> CowHashMap<'a, K, V> where K: Hash + ?Sized + PartialEq + Eq + ToOwned, V: ToOwned + ?Sized, { /// Creates a new `CowHashMap`. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let hm: CowHashMap<str, String> = CowHashMap::new(); /// ``` #[inline] pub fn new() -> Self { CowHashMap { inner: HashMap::new() } } /// Creates a new `CowHashMap` with the specified capacity. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let hm: CowHashMap<str, String> = CowHashMap::with_capacity(5); /// assert!(hm.capacity() >= 5); /// ``` #[inline] pub fn with_capacity(capacity: usize) -> Self { CowHashMap { inner: HashMap::with_capacity(capacity) } } /// Returns the number of elements the map can hold without reallocating. /// /// This number is a lower bound; the map might be able to hold more elements, but is guaranteed to be able to hold at least this many elements. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// assert_eq!(hm.capacity(), 0); /// ``` #[inline] pub fn capacity(&self) -> usize { self.inner.capacity() } /// Reserves capacity for at least additional more elements to be inserted in the map. /// The collection may reserve more space to avoid frequent reallocations. #[inline] pub fn reserve(&mut self, additional: usize) { self.inner.reserve(additional); } /// Shrinks the map as much as possible while retaining the number of elements. #[inline] pub fn shrink_to_fit(&mut self) { self.inner.shrink_to_fit(); } /// Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse. #[inline] pub fn clear(&mut self) { self.inner.clear(); } /// Returns true if the map contains no elements. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// assert!(hm.is_empty()); /// /// hm.insert_owned("key".to_owned(), vec![1, 2, 3]); /// assert!(!hm.is_empty()); /// ``` #[inline] pub fn is_empty(&self) -> bool { self.len() == 0 } /// Inserts a new key/value pair into the map with the value /// being in the owned form. /// /// This function returns `None` if there was no value previously /// associated with the given key. If the key is replaced, this /// function returns the previous value. If the previous value /// is borrowed, it will be cloned and then returned. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_owned("key".to_owned(), vec![1, 2, 3]); /// /// assert_eq!(hm.len(), 1); /// ``` #[inline] pub fn insert_owned(&mut self, key: <K as ToOwned>::Owned, value: <V as ToOwned>::Owned) -> Option<<V as ToOwned>::Owned> { self.inner.insert(Cow::Owned(key), Cow::Owned(value)).map(|x| x.into_owned()) } /// Inserts a new key/value pair into the map with the value /// being in the owned form and the key in borrowed form. /// /// This function returns `None` if there was no value previously /// associated with the given key. If the key is replaced, this /// function returns the previous value. If the previous value /// is borrowed, it will be cloned and then returned. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_owned_borrowed_key("key", vec![1, 2, 3]); /// /// assert_eq!(hm.len(), 1); /// ``` #[inline] pub fn insert_owned_borrowed_key(&mut self, key: &'a K, value: <V as ToOwned>::Owned) -> Option<<V as ToOwned>::Owned> { self.inner.insert(Cow::Borrowed(key), Cow::Owned(value)).map(|x| x.into_owned()) } /// Inserts a new key/value pair in to the map with the value /// being in borrowed form. /// /// This function returns `None` if there was no value previously /// associated with the given key. If the key is replaced, this /// function returns the previous value. If the previous value /// is borrowed, it will be cloned and then returned. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_borrowed("key", &[1, 2, 3]); /// /// assert_eq!(hm.len(), 1); /// ``` #[inline] pub fn insert_borrowed(&mut self, key: &'a K, value: &'a V) -> Option<<V as ToOwned>::Owned> { self.inner.insert(Cow::Borrowed(key), Cow::Borrowed(value)).map(|x| x.into_owned()) } /// Inserts a new key/value pair in to the map with the value /// being in borrowed form and the key in owned form. /// /// This function returns `None` if there was no value previously /// associated with the given key. If the key is replaced, this /// function returns the previous value. If the previous value /// is borrowed, it will be cloned and then returned. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_borrowed_owned_key("key".to_owned(), &[1, 2, 3]); /// /// assert_eq!(hm.len(), 1); /// ``` #[inline] pub fn insert_borrowed_owned_key(&mut self, key: <K as ToOwned>::Owned, value: &'a V) -> Option<<V as ToOwned>::Owned> { self.inner.insert(Cow::Owned(key), Cow::Borrowed(value)).map(|x| x.into_owned()) } /// Attempts to retrieve a reference to an item stored in the map. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_borrowed("key1", &[1, 2, 3]); /// hm.insert_owned("key2".to_owned(), vec![4, 5, 6]); /// /// assert_eq!(hm.len(), 2); /// assert_eq!(hm.get(&"key1").unwrap(), &[1, 2, 3]); /// assert_eq!(hm.get(&"key2").unwrap(), &[4, 5, 6]); /// ``` #[inline] pub fn get(&self, key: &K) -> Option<&V> { self.inner.get(key).map(|v| v.as_ref()) } /// Attempts to retrieve a mutable reference to the owned /// form of an item stored in the map. /// /// If the stored entry is in the borrowed form, this function /// will clone the underlying data. /// /// ## Example /// ```rust /// use hashcow::{Form, CowHashMap}; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_borrowed("key1", &[1, 2, 3]); /// /// assert_eq!(hm.entry_form(&"key1").unwrap(), Form::Borrowed); /// /// { /// // This will clone the entry stored at this key /// let entry = hm.get_mut(&"key1").unwrap(); /// assert_eq!(entry, &mut vec![1, 2, 3]); /// /// *entry = vec![4, 5, 6]; /// } /// /// assert_eq!(hm.entry_form(&"key1").unwrap(), Form::Owned); /// assert_eq!(hm.get(&"key1").unwrap(), &[4, 5, 6]); /// ``` #[inline] pub fn get_mut(&mut self, key: &K) -> Option<&mut <V as ToOwned>::Owned> { self.inner.get_mut(key).map(|v| v.to_mut()) } #[inline] /// Returns an iterator over the keys of the map. /// /// ## Example /// ```rust /// # #[macro_use] extern crate hashcow; fn main() { /// # use std::collections::HashSet; /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_borrowed("key1", &[1, 2, 3]); /// hm.insert_owned("key2".to_owned(), vec![4, 5, 6]); /// /// let keys: HashSet<&str> = hm.keys().collect(); /// assert_eq!(keys, set!["key1", "key2"]); /// # } /// ``` #[inline] pub fn keys(&self) -> impl Iterator<Item = &K> { self.inner.keys().map(|k| k.borrow()) } /// Makes a specific value in the map owned, if it isn't so already. /// /// This function does not do anything if the value is already in owned /// form. #[inline] pub fn make_owned(&mut self, key: &K) -> Option<&V> { let val = self.inner.get_mut(key)?; match val { Cow::Borrowed(v) => { *val = Cow::Owned(v.to_owned()); self.inner.get(key).map(|v| v.as_ref()) } Cow::Owned(_) => { self.inner.get(key).map(|v| v.as_ref()) } } } /// Returns the number of elements that are currently in the map. #[inline] pub fn len(&self) -> usize { self.inner.len() } /// If an entry with the given key exists, this function /// returns the underlying form in which it is stored in /// the map. /// /// Can be either `Form::Borrowed` or `Form::Owned`. #[inline] pub fn entry_form(&self, key: &K) -> Option<Form> { let val = self.inner.get(key)?; match val { Cow::Borrowed(_) => Some(Form::Borrowed), Cow::Owned(_) => Some(Form::Owned), } } /// Returns a cloned version of the map but with /// the entries in borrowed form. /// /// ## Example /// ```rust /// use hashcow::{Form, CowHashMap}; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_owned("key".to_owned(), vec![1, 2, 3]); /// /// assert_eq!(hm.entry_form(&"key").unwrap(), Form::Owned); /// /// let hm_clone = hm.borrow_fields(); /// assert_eq!(hm_clone.entry_form(&"key").unwrap(), Form::Borrowed); /// ``` #[inline] pub fn borrow_fields(&'a self) -> Self { let collection: HashMap<Cow<'a, K>, Cow<'a, V>> = self.inner .iter() .map(|(k, v)| { match (k, v) { (Cow::Owned(key), Cow::Owned(val)) => { (Cow::Borrowed((*key).borrow()), Cow::Borrowed((*val).borrow())) } (Cow::Borrowed(key), Cow::Owned(val)) => { (Cow::Borrowed(*key), Cow::Borrowed((*val).borrow())) } (Cow::Owned(key), Cow::Borrowed(val)) => { (Cow::Borrowed((*key).borrow()), Cow::Borrowed(*val)) } (Cow::Borrowed(key), Cow::Borrowed(val)) => { (Cow::Borrowed(*key), Cow::Borrowed(*val)) } } }) .collect(); CowHashMap { inner: collection } } /// An iterator visiting all key-value pairs in arbitrary order. /// /// ## Example /// ```rust /// # #[macro_use] extern crate hashcow; fn main() { /// # use std::collections::HashSet; /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// hm.insert_borrowed("key1", &[1, 2, 3]); /// hm.insert_owned("key2".to_owned(), vec![4, 5, 6]); /// /// for (key, val) in hm.iter() { /// // ... /// } /// # } /// ``` #[inline] pub fn iter(&self) -> impl Iterator<Item = (&K, &V)> { self.inner.iter().map(|(k, v)| (k.borrow(), v.borrow())) } /// Removes a key from the map, returning the value at the key if the key was previously in the map. /// /// ## Example /// ```rust /// use hashcow::CowHashMap; /// /// let mut hm: CowHashMap<str, [u8]> = CowHashMap::new(); /// assert!(hm.remove(&"key1").is_none()); /// /// hm.insert_borrowed("key1", &[1, 2, 3]); /// assert_eq!(hm.remove(&"key1").unwrap(), vec![1, 2, 3]); /// ``` pub fn remove(&mut self, key: &K) -> Option<<V as ToOwned>::Owned> { let val = self.inner.remove(key)?; match val { Cow::Borrowed(val) => Some(val.to_owned()), Cow::Owned(val) => Some(val), } } } #[macro_use] mod macros; #[cfg(test)] mod tests { use super::*; }