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
use crate::iter::*;
use crate::reclaim::{Guard, GuardRef};
use crate::{HashMap, TryInsertError};
use std::borrow::Borrow;
use std::fmt::{self, Debug, Formatter};
use std::hash::{BuildHasher, Hash};
use std::ops::Index;
/// A reference to a [`HashMap`], constructed with [`HashMap::pin`] or [`HashMap::with_guard`].
///
/// The current thread will be pinned for the duration of this reference.
/// Keep in mind that this prevents the collection of garbage generated by the map.
pub struct HashMapRef<'map, K, V, S = crate::DefaultHashBuilder> {
pub(crate) map: &'map HashMap<K, V, S>,
guard: GuardRef<'map>,
}
impl<K, V, S> HashMap<K, V, S> {
/// Get a reference to this map with the current thread pinned.
///
/// Keep in mind that for as long as you hold onto this, you are preventing the collection of
/// garbage generated by the map.
pub fn pin(&self) -> HashMapRef<'_, K, V, S> {
HashMapRef {
guard: GuardRef::Owned(self.guard()),
map: self,
}
}
/// Get a reference to this map with the given guard.
pub fn with_guard<'g>(&'g self, guard: &'g Guard<'_>) -> HashMapRef<'g, K, V, S> {
HashMapRef {
guard: GuardRef::Ref(guard),
map: self,
}
}
}
impl<K, V, S> HashMapRef<'_, K, V, S> {
/// Returns the number of entries in the map.
///
/// See also [`HashMap::len`].
pub fn len(&self) -> usize {
self.map.len()
}
/// Returns `true` if the map is empty. Otherwise returns `false`.
///
/// See also [`HashMap::is_empty`].
pub fn is_empty(&self) -> bool {
self.map.is_empty()
}
/// An iterator visiting all key-value pairs in arbitrary order.
///
/// The iterator element type is `(&'g K, &'g V)`.
///
/// See also [`HashMap::iter`].
pub fn iter(&self) -> Iter<'_, K, V> {
self.map.iter(&self.guard)
}
/// An iterator visiting all keys in arbitrary order.
///
/// The iterator element type is `&'g K`.
///
/// See also [`HashMap::keys`].
pub fn keys(&self) -> Keys<'_, K, V> {
self.map.keys(&self.guard)
}
/// An iterator visiting all values in arbitrary order.
///
/// The iterator element type is `&'g V`.
///
/// See also [`HashMap::values`].
pub fn values(&self) -> Values<'_, K, V> {
self.map.values(&self.guard)
}
}
impl<K, V, S> HashMapRef<'_, K, V, S>
where
K: Clone + Ord,
{
/// Tries to reserve capacity for at least `additional` more elements to be inserted in the
/// `HashMap`.
///
/// The collection may reserve more space to avoid frequent reallocations.
///
/// See also [`HashMap::reserve`].
pub fn reserve(&self, additional: usize) {
self.map.reserve(additional, &self.guard)
}
}
impl<K, V, S> HashMapRef<'_, K, V, S>
where
K: Hash + Ord,
S: BuildHasher,
{
/// Returns `true` if the map contains a value for the specified key.
///
/// See also [`HashMap::contains_key`].
pub fn contains_key<Q>(&self, key: &Q) -> bool
where
K: Borrow<Q>,
Q: ?Sized + Hash + Ord,
{
self.map.contains_key(key, &self.guard)
}
/// Returns a reference to the value corresponding to the key.
///
/// See also [`HashMap::get`].
#[inline]
pub fn get<'g, Q>(&'g self, key: &Q) -> Option<&'g V>
where
K: Borrow<Q>,
Q: ?Sized + Hash + Ord,
{
self.map.get(key, &self.guard)
}
/// Returns the key-value pair corresponding to `key`.
///
/// See also [`HashMap::get_key_value`].
#[inline]
pub fn get_key_value<'g, Q>(&'g self, key: &Q) -> Option<(&'g K, &'g V)>
where
K: Borrow<Q>,
Q: ?Sized + Hash + Ord,
{
self.map.get_key_value(key, &self.guard)
}
}
impl<K, V, S> HashMapRef<'_, K, V, S>
where
K: Clone + Ord,
{
/// Clears the map, removing all key-value pairs.
///
/// See also [`HashMap::clear`].
pub fn clear(&self) {
self.map.clear(&self.guard);
}
}
impl<K, V, S> HashMapRef<'_, K, V, S>
where
K: Sync + Send + Clone + Hash + Ord,
V: Sync + Send,
S: BuildHasher,
{
/// Inserts a key-value pair into the map.
///
/// See also [`HashMap::insert`].
pub fn insert(&self, key: K, value: V) -> Option<&'_ V> {
self.map.insert(key, value, &self.guard)
}
/// Inserts a key-value pair into the map unless the key already exists.
///
/// See also [`HashMap::try_insert`].
#[inline]
pub fn try_insert(&self, key: K, value: V) -> Result<&'_ V, TryInsertError<'_, V>> {
self.map.try_insert(key, value, &self.guard)
}
/// If the value for the specified `key` is present, attempts to
/// compute a new mapping given the key and its current mapped value.
///
/// See also [`HashMap::compute_if_present`].
pub fn compute_if_present<'g, Q, F>(&'g self, key: &Q, remapping_function: F) -> Option<&'g V>
where
K: Borrow<Q>,
Q: ?Sized + Hash + Ord,
F: FnOnce(&K, &V) -> Option<V>,
{
self.map
.compute_if_present(key, remapping_function, &self.guard)
}
/// Removes a key-value pair from the map, and returns the removed value (if any).
///
/// See also [`HashMap::remove`].
pub fn remove<'g, Q>(&'g self, key: &Q) -> Option<&'g V>
where
K: Borrow<Q>,
Q: ?Sized + Hash + Ord,
{
self.map.remove(key, &self.guard)
}
/// Removes a key from the map, returning the stored key and value if the
/// key was previously in the map.
///
/// See also [`HashMap::remove_entry`].
pub fn remove_entry<'g, Q>(&'g self, key: &Q) -> Option<(&'g K, &'g V)>
where
K: Borrow<Q>,
Q: ?Sized + Hash + Ord,
{
self.map.remove_entry(key, &self.guard)
}
/// Retains only the elements specified by the predicate.
///
/// See also [`HashMap::retain`].
pub fn retain<F>(&self, f: F)
where
F: FnMut(&K, &V) -> bool,
{
self.map.retain(f, &self.guard);
}
/// Retains only the elements specified by the predicate.
///
/// See also [`HashMap::retain_force`].
pub fn retain_force<F>(&self, f: F)
where
F: FnMut(&K, &V) -> bool,
{
self.map.retain_force(f, &self.guard);
}
}
impl<'g, K, V, S> IntoIterator for &'g HashMapRef<'_, K, V, S> {
type IntoIter = Iter<'g, K, V>;
type Item = (&'g K, &'g V);
fn into_iter(self) -> Self::IntoIter {
self.map.iter(&self.guard)
}
}
impl<K, V, S> Debug for HashMapRef<'_, K, V, S>
where
K: Debug,
V: Debug,
{
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_map().entries(self).finish()
}
}
impl<K, V, S> Clone for HashMapRef<'_, K, V, S> {
fn clone(&self) -> Self {
self.map.pin()
}
}
impl<K, V, S> PartialEq for HashMapRef<'_, K, V, S>
where
K: Hash + Ord,
V: PartialEq,
S: BuildHasher,
{
fn eq(&self, other: &Self) -> bool {
self.map.guarded_eq(other.map, &self.guard, &other.guard)
}
}
impl<K, V, S> PartialEq<HashMap<K, V, S>> for HashMapRef<'_, K, V, S>
where
K: Hash + Ord,
V: PartialEq,
S: BuildHasher,
{
fn eq(&self, other: &HashMap<K, V, S>) -> bool {
self.map.guarded_eq(other, &self.guard, &other.guard())
}
}
impl<K, V, S> PartialEq<HashMapRef<'_, K, V, S>> for HashMap<K, V, S>
where
K: Hash + Ord,
V: PartialEq,
S: BuildHasher,
{
fn eq(&self, other: &HashMapRef<'_, K, V, S>) -> bool {
self.guarded_eq(other.map, &self.guard(), &other.guard)
}
}
impl<K, V, S> Eq for HashMapRef<'_, K, V, S>
where
K: Hash + Ord,
V: Eq,
S: BuildHasher,
{
}
impl<K, Q, V, S> Index<&'_ Q> for HashMapRef<'_, K, V, S>
where
K: Hash + Ord + Borrow<Q>,
Q: ?Sized + Hash + Ord,
S: BuildHasher,
{
type Output = V;
fn index(&self, key: &Q) -> &V {
self.get(key).expect("no entry found for key")
}
}