slotmap/hop.rs
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 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
// Needed because assigning to non-Copy union is unsafe in stable but not in nightly.
#![allow(unused_unsafe)]
//! Contains the faster iteration, slower insertion/removal slot map
//! implementation.
//!
//! This data structure is essentially the same as a regular [`SlotMap`], but
//! maintains extra information when inserting/removing elements that allows it
//! to 'hop over' vacant slots during iteration, making it potentially much
//! faster for iteration.
//!
//! The trade-off is that compared to a regular [`SlotMap`] insertion/removal is
//! roughly twice as slow. Random indexing has identical performance for both.
//!
//! [`SlotMap`]: crate::SlotMap
#[cfg(all(nightly, any(doc, feature = "unstable")))]
use alloc::collections::TryReserveError;
use alloc::vec::Vec;
use core::fmt;
use core::iter::FusedIterator;
use core::marker::PhantomData;
use core::mem::ManuallyDrop;
#[allow(unused_imports)] // MaybeUninit is only used on nightly at the moment.
use core::mem::MaybeUninit;
use core::ops::{Index, IndexMut};
use crate::util::{Never, UnwrapUnchecked};
use crate::{DefaultKey, Key, KeyData};
// Metadata to maintain the freelist.
#[derive(Clone, Copy, Debug)]
struct FreeListEntry {
next: u32,
prev: u32,
other_end: u32,
}
// Storage inside a slot or metadata for the freelist when vacant.
union SlotUnion<T> {
value: ManuallyDrop<T>,
free: FreeListEntry,
}
// A slot, which represents storage for a value and a current version.
// Can be occupied or vacant.
struct Slot<T> {
u: SlotUnion<T>,
version: u32, // Even = vacant, odd = occupied.
}
// Safe API to read a slot.
enum SlotContent<'a, T: 'a> {
Occupied(&'a T),
Vacant(&'a FreeListEntry),
}
enum SlotContentMut<'a, T: 'a> {
OccupiedMut(&'a mut T),
VacantMut(&'a mut FreeListEntry),
}
use self::SlotContent::{Occupied, Vacant};
use self::SlotContentMut::{OccupiedMut, VacantMut};
impl<T> Slot<T> {
// Is this slot occupied?
#[inline(always)]
pub fn occupied(&self) -> bool {
self.version % 2 == 1
}
pub fn get(&self) -> SlotContent<T> {
unsafe {
if self.occupied() {
Occupied(&*self.u.value)
} else {
Vacant(&self.u.free)
}
}
}
pub fn get_mut(&mut self) -> SlotContentMut<T> {
unsafe {
if self.occupied() {
OccupiedMut(&mut *self.u.value)
} else {
VacantMut(&mut self.u.free)
}
}
}
}
impl<T> Drop for Slot<T> {
fn drop(&mut self) {
if core::mem::needs_drop::<T>() && self.occupied() {
// This is safe because we checked that we're occupied.
unsafe {
ManuallyDrop::drop(&mut self.u.value);
}
}
}
}
impl<T: Clone> Clone for Slot<T> {
fn clone(&self) -> Self {
Self {
u: match self.get() {
Occupied(value) => SlotUnion {
value: ManuallyDrop::new(value.clone()),
},
Vacant(&free) => SlotUnion { free },
},
version: self.version,
}
}
fn clone_from(&mut self, source: &Self) {
match (self.get_mut(), source.get()) {
(OccupiedMut(self_val), Occupied(source_val)) => self_val.clone_from(source_val),
(VacantMut(self_free), Vacant(&source_free)) => *self_free = source_free,
(_, Occupied(value)) => {
self.u = SlotUnion {
value: ManuallyDrop::new(value.clone()),
}
},
(_, Vacant(&free)) => self.u = SlotUnion { free },
}
self.version = source.version;
}
}
impl<T: fmt::Debug> fmt::Debug for Slot<T> {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
let mut builder = fmt.debug_struct("Slot");
builder.field("version", &self.version);
match self.get() {
Occupied(value) => builder.field("value", value).finish(),
Vacant(free) => builder.field("free", free).finish(),
}
}
}
/// Hop slot map, storage with stable unique keys.
///
/// See [crate documentation](crate) for more details.
#[derive(Debug)]
pub struct HopSlotMap<K: Key, V> {
slots: Vec<Slot<V>>,
num_elems: u32,
_k: PhantomData<fn(K) -> K>,
}
impl<V> HopSlotMap<DefaultKey, V> {
/// Constructs a new, empty [`HopSlotMap`].
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm: HopSlotMap<_, i32> = HopSlotMap::new();
/// ```
pub fn new() -> Self {
Self::with_capacity_and_key(0)
}
/// Creates an empty [`HopSlotMap`] with the given capacity.
///
/// The slot map will not reallocate until it holds at least `capacity`
/// elements.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm: HopSlotMap<_, i32> = HopSlotMap::with_capacity(10);
/// ```
pub fn with_capacity(capacity: usize) -> Self {
Self::with_capacity_and_key(capacity)
}
}
impl<K: Key, V> HopSlotMap<K, V> {
/// Constructs a new, empty [`HopSlotMap`] with a custom key type.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// new_key_type! {
/// struct PositionKey;
/// }
/// let mut positions: HopSlotMap<PositionKey, i32> = HopSlotMap::with_key();
/// ```
pub fn with_key() -> Self {
Self::with_capacity_and_key(0)
}
/// Creates an empty [`HopSlotMap`] with the given capacity and a custom key
/// type.
///
/// The slot map will not reallocate until it holds at least `capacity`
/// elements.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// new_key_type! {
/// struct MessageKey;
/// }
/// let mut messages = HopSlotMap::with_capacity_and_key(3);
/// let welcome: MessageKey = messages.insert("Welcome");
/// let good_day = messages.insert("Good day");
/// let hello = messages.insert("Hello");
/// ```
pub fn with_capacity_and_key(capacity: usize) -> Self {
// Create slots with sentinel at index 0.
let mut slots = Vec::with_capacity(capacity + 1);
slots.push(Slot {
u: SlotUnion {
free: FreeListEntry {
next: 0,
prev: 0,
other_end: 0,
},
},
version: 0,
});
Self {
slots,
num_elems: 0,
_k: PhantomData,
}
}
/// Returns the number of elements in the slot map.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::with_capacity(10);
/// sm.insert("len() counts actual elements, not capacity");
/// let key = sm.insert("removed elements don't count either");
/// sm.remove(key);
/// assert_eq!(sm.len(), 1);
/// ```
pub fn len(&self) -> usize {
self.num_elems as usize
}
/// Returns if the slot map is empty.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert("dummy");
/// assert_eq!(sm.is_empty(), false);
/// sm.remove(key);
/// assert_eq!(sm.is_empty(), true);
/// ```
pub fn is_empty(&self) -> bool {
self.num_elems == 0
}
/// Returns the number of elements the [`HopSlotMap`] can hold without
/// reallocating.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let sm: HopSlotMap<_, f64> = HopSlotMap::with_capacity(10);
/// assert_eq!(sm.capacity(), 10);
/// ```
pub fn capacity(&self) -> usize {
// One slot is reserved for the freelist sentinel.
self.slots.capacity() - 1
}
/// Reserves capacity for at least `additional` more elements to be inserted
/// in the [`HopSlotMap`]. The collection may reserve more space to
/// avoid frequent reallocations.
///
/// # Panics
///
/// Panics if the new allocation size overflows [`usize`].
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// sm.insert("foo");
/// sm.reserve(32);
/// assert!(sm.capacity() >= 33);
/// ```
pub fn reserve(&mut self, additional: usize) {
// One slot is reserved for the freelist sentinel.
let needed = (self.len() + additional).saturating_sub(self.slots.len() - 1);
self.slots.reserve(needed);
}
/// Tries to reserve capacity for at least `additional` more elements to be
/// inserted in the [`HopSlotMap`]. The collection may reserve more space to
/// avoid frequent reallocations.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// sm.insert("foo");
/// sm.try_reserve(32).unwrap();
/// assert!(sm.capacity() >= 33);
/// ```
#[cfg(all(nightly, any(doc, feature = "unstable")))]
#[cfg_attr(all(nightly, doc), doc(cfg(feature = "unstable")))]
pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> {
// One slot is reserved for the freelist sentinel.
let needed = (self.len() + additional).saturating_sub(self.slots.len() - 1);
self.slots.try_reserve(needed)
}
/// Returns [`true`] if the slot map contains `key`.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert(42);
/// assert_eq!(sm.contains_key(key), true);
/// sm.remove(key);
/// assert_eq!(sm.contains_key(key), false);
/// ```
pub fn contains_key(&self, key: K) -> bool {
let kd = key.data();
self.slots
.get(kd.idx as usize)
.map_or(false, |slot| slot.version == kd.version.get())
}
/// Inserts a value into the slot map. Returns a unique key that can be
/// used to access this value.
///
/// # Panics
///
/// Panics if the number of elements in the slot map equals
/// 2<sup>32</sup> - 2.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert(42);
/// assert_eq!(sm[key], 42);
/// ```
#[inline(always)]
pub fn insert(&mut self, value: V) -> K {
unsafe { self.try_insert_with_key::<_, Never>(move |_| Ok(value)).unwrap_unchecked_() }
}
// Helper function to make using the freelist painless.
// For that same ergonomy it uses u32, not usize as index.
// Safe iff idx is a valid index and the slot at that index is vacant.
unsafe fn freelist(&mut self, idx: u32) -> &mut FreeListEntry {
&mut self.slots.get_unchecked_mut(idx as usize).u.free
}
/// Inserts a value given by `f` into the slot map. The key where the
/// value will be stored is passed into `f`. This is useful to store values
/// that contain their own key.
///
/// # Panics
///
/// Panics if the number of elements in the slot map equals
/// 2<sup>32</sup> - 2.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert_with_key(|k| (k, 20));
/// assert_eq!(sm[key], (key, 20));
/// ```
#[inline(always)]
pub fn insert_with_key<F>(&mut self, f: F) -> K
where
F: FnOnce(K) -> V,
{
unsafe { self.try_insert_with_key::<_, Never>(move |k| Ok(f(k))).unwrap_unchecked_() }
}
/// Inserts a value given by `f` into the slot map. The key where the
/// value will be stored is passed into `f`. This is useful to store values
/// that contain their own key.
///
/// If `f` returns `Err`, this method returns the error. The slotmap is untouched.
///
/// # Panics
///
/// Panics if the number of elements in the slot map equals
/// 2<sup>32</sup> - 2.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.try_insert_with_key::<_, ()>(|k| Ok((k, 20))).unwrap();
/// assert_eq!(sm[key], (key, 20));
///
/// sm.try_insert_with_key::<_, ()>(|k| Err(())).unwrap_err();
/// ```
pub fn try_insert_with_key<F, E>(&mut self, f: F) -> Result<K, E>
where
F: FnOnce(K) -> Result<V, E>,
{
// In case f panics, we don't make any changes until we have the value.
let new_num_elems = self.num_elems + 1;
if new_num_elems == core::u32::MAX {
panic!("HopSlotMap number of elements overflow");
}
// All unsafe accesses here are safe due to the invariants of the slot
// map freelist.
unsafe {
let head = self.freelist(0).next;
// We have a contiguous block of vacant slots starting at head.
// Put our new element at the back slot.
let front = head;
let back = self.freelist(front).other_end;
let slot_idx = back as usize;
// Freelist is empty.
if slot_idx == 0 {
let version = 1;
let key = KeyData::new(self.slots.len() as u32, version).into();
self.slots.push(Slot {
u: SlotUnion {
value: ManuallyDrop::new(f(key)?),
},
version,
});
self.num_elems = new_num_elems;
return Ok(key);
}
// Compute value first in case f panics or returns an error.
let occupied_version = self.slots[slot_idx].version | 1;
let key = KeyData::new(slot_idx as u32, occupied_version).into();
let value = f(key)?;
// Update freelist.
if front == back {
// Used last slot in this block, move next one to head.
let new_head = self.freelist(front).next;
self.freelist(0).next = new_head;
self.freelist(new_head).prev = 0;
} else {
// Continue using this block, only need to update other_ends.
let new_back = back - 1;
self.freelist(new_back).other_end = front;
self.freelist(front).other_end = new_back;
}
// And finally insert the value.
let slot = &mut self.slots[slot_idx];
slot.version = occupied_version;
slot.u.value = ManuallyDrop::new(value);
self.num_elems = new_num_elems;
Ok(key)
}
}
// Helper function to remove a value from a slot. Safe iff the slot is
// occupied. Returns the value removed.
#[inline(always)]
unsafe fn remove_from_slot(&mut self, idx: usize) -> V {
// Remove value from slot.
let slot = self.slots.get_unchecked_mut(idx);
slot.version = slot.version.wrapping_add(1);
let value = ManuallyDrop::take(&mut slot.u.value);
// This is safe and can't underflow because of the sentinel element at
// the start.
let left_vacant = !self.slots.get_unchecked(idx - 1).occupied();
let right_vacant = self.slots.get(idx + 1).map_or(false, |s| !s.occupied());
// Maintain freelist by either appending/prepending this slot to a
// contiguous block to the left or right, merging the two blocks to the
// left and right or inserting a new block.
let i = idx as u32;
match (left_vacant, right_vacant) {
(false, false) => {
// New block, insert it at the tail.
let old_tail = self.freelist(0).prev;
self.freelist(0).prev = i;
self.freelist(old_tail).next = i;
*self.freelist(i) = FreeListEntry {
other_end: i,
next: 0,
prev: old_tail,
};
},
(false, true) => {
// Prepend to vacant block on right.
let front_data = *self.freelist(i + 1);
// Since the start of this block moved we must update the pointers to it.
self.freelist(front_data.other_end).other_end = i;
self.freelist(front_data.prev).next = i;
self.freelist(front_data.next).prev = i;
*self.freelist(i) = front_data;
},
(true, false) => {
// Append to vacant block on left.
let front = self.freelist(i - 1).other_end;
self.freelist(i).other_end = front;
self.freelist(front).other_end = i;
},
(true, true) => {
// We must merge left and right.
// First snip right out of the freelist.
let right = *self.freelist(i + 1);
self.freelist(right.prev).next = right.next;
self.freelist(right.next).prev = right.prev;
// Now update endpoints.
let front = self.freelist(i - 1).other_end;
let back = right.other_end;
self.freelist(front).other_end = back;
self.freelist(back).other_end = front;
},
}
self.num_elems -= 1;
value
}
/// Removes a key from the slot map, returning the value at the key if the
/// key was not previously removed.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert(42);
/// assert_eq!(sm.remove(key), Some(42));
/// assert_eq!(sm.remove(key), None);
/// ```
pub fn remove(&mut self, key: K) -> Option<V> {
let kd = key.data();
if self.contains_key(key) {
// This is safe because we know that the slot is occupied.
Some(unsafe { self.remove_from_slot(kd.idx as usize) })
} else {
None
}
}
/// Retains only the elements specified by the predicate.
///
/// In other words, remove all key-value pairs `(k, v)` such that
/// `f(k, &mut v)` returns false. This method invalidates any removed keys.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
///
/// let k1 = sm.insert(0);
/// let k2 = sm.insert(1);
/// let k3 = sm.insert(2);
///
/// sm.retain(|key, val| key == k1 || *val == 1);
///
/// assert!(sm.contains_key(k1));
/// assert!(sm.contains_key(k2));
/// assert!(!sm.contains_key(k3));
///
/// assert_eq!(2, sm.len());
/// ```
pub fn retain<F>(&mut self, mut f: F)
where
F: FnMut(K, &mut V) -> bool,
{
let mut elems_left_to_scan = self.len();
let mut cur = unsafe { self.slots.get_unchecked(0).u.free.other_end as usize + 1 };
while elems_left_to_scan > 0 {
// This is safe because removing elements does not shrink slots, cur always
// points to an occupied slot.
let idx = cur;
let slot = unsafe { self.slots.get_unchecked_mut(cur) };
let version = slot.version;
let key = KeyData::new(cur as u32, version).into();
let should_remove = !f(key, unsafe { &mut *slot.u.value });
cur = match self.slots.get(cur + 1).map(|s| s.get()) {
Some(Occupied(_)) => cur + 1,
Some(Vacant(free)) => free.other_end as usize + 1,
None => 0,
};
if should_remove {
// This must happen after getting the next index.
unsafe { self.remove_from_slot(idx) };
}
elems_left_to_scan -= 1;
}
}
/// Clears the slot map. Keeps the allocated memory for reuse.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// for i in 0..10 {
/// sm.insert(i);
/// }
/// assert_eq!(sm.len(), 10);
/// sm.clear();
/// assert_eq!(sm.len(), 0);
/// ```
pub fn clear(&mut self) {
self.drain();
}
/// Clears the slot map, returning all key-value pairs in arbitrary order as
/// an iterator. Keeps the allocated memory for reuse.
///
/// When the iterator is dropped all elements in the slot map are removed,
/// even if the iterator was not fully consumed. If the iterator is not
/// dropped (using e.g. [`std::mem::forget`]), only the elements that were
/// iterated over are removed.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let k = sm.insert(0);
/// let v: Vec<_> = sm.drain().collect();
/// assert_eq!(sm.len(), 0);
/// assert_eq!(v, vec![(k, 0)]);
/// ```
pub fn drain(&mut self) -> Drain<K, V> {
Drain {
cur: unsafe { self.slots.get_unchecked(0).u.free.other_end as usize + 1 },
sm: self,
}
}
/// Returns a reference to the value corresponding to the key.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert("bar");
/// assert_eq!(sm.get(key), Some(&"bar"));
/// sm.remove(key);
/// assert_eq!(sm.get(key), None);
/// ```
pub fn get(&self, key: K) -> Option<&V> {
let kd = key.data();
// This is safe because we check version first and a key always contains
// an odd version, thus we are occupied.
self.slots
.get(kd.idx as usize)
.filter(|slot| slot.version == kd.version.get())
.map(|slot| unsafe { &*slot.u.value })
}
/// Returns a reference to the value corresponding to the key without
/// version or bounds checking.
///
/// # Safety
///
/// This should only be used if `contains_key(key)` is true. Otherwise it is
/// dangerous undefined behavior.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert("bar");
/// assert_eq!(unsafe { sm.get_unchecked(key) }, &"bar");
/// sm.remove(key);
/// // sm.get_unchecked(key) is now dangerous!
/// ```
pub unsafe fn get_unchecked(&self, key: K) -> &V {
debug_assert!(self.contains_key(key));
&self.slots.get_unchecked(key.data().idx as usize).u.value
}
/// Returns a mutable reference to the value corresponding to the key.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert(3.5);
/// if let Some(x) = sm.get_mut(key) {
/// *x += 3.0;
/// }
/// assert_eq!(sm[key], 6.5);
/// ```
pub fn get_mut(&mut self, key: K) -> Option<&mut V> {
let kd = key.data();
// This is safe because we check version first and a key always contains
// an odd version, thus we are occupied.
self.slots
.get_mut(kd.idx as usize)
.filter(|slot| slot.version == kd.version.get())
.map(|slot| unsafe { &mut *slot.u.value })
}
/// Returns a mutable reference to the value corresponding to the key
/// without version or bounds checking.
///
/// # Safety
///
/// This should only be used if `contains_key(key)` is true. Otherwise it is
/// dangerous undefined behavior.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let key = sm.insert("foo");
/// unsafe { *sm.get_unchecked_mut(key) = "bar" };
/// assert_eq!(sm[key], "bar");
/// sm.remove(key);
/// // sm.get_unchecked_mut(key) is now dangerous!
/// ```
pub unsafe fn get_unchecked_mut(&mut self, key: K) -> &mut V {
debug_assert!(self.contains_key(key));
&mut self.slots.get_unchecked_mut(key.data().idx as usize).u.value
}
/// Returns mutable references to the values corresponding to the given
/// keys. All keys must be valid and disjoint, otherwise [`None`] is
/// returned.
///
/// Requires at least stable Rust version 1.51.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let ka = sm.insert("butter");
/// let kb = sm.insert("apples");
/// let kc = sm.insert("charlie");
/// sm.remove(kc); // Make key c invalid.
/// assert_eq!(sm.get_disjoint_mut([ka, kb, kc]), None); // Has invalid key.
/// assert_eq!(sm.get_disjoint_mut([ka, ka]), None); // Not disjoint.
/// let [a, b] = sm.get_disjoint_mut([ka, kb]).unwrap();
/// std::mem::swap(a, b);
/// assert_eq!(sm[ka], "apples");
/// assert_eq!(sm[kb], "butter");
/// ```
#[cfg(has_min_const_generics)]
pub fn get_disjoint_mut<const N: usize>(&mut self, keys: [K; N]) -> Option<[&mut V; N]> {
// Create an uninitialized array of `MaybeUninit`. The `assume_init` is
// safe because the type we are claiming to have initialized here is a
// bunch of `MaybeUninit`s, which do not require initialization.
let mut ptrs: [MaybeUninit<*mut V>; N] = unsafe { MaybeUninit::uninit().assume_init() };
let mut i = 0;
while i < N {
// We can avoid this clone after min_const_generics and array_map.
let kd = keys[i].data();
if !self.contains_key(kd.into()) {
break;
}
// This key is valid, and thus the slot is occupied. Temporarily
// mark it as unoccupied so duplicate keys would show up as invalid.
// This gives us a linear time disjointness check.
unsafe {
let slot = self.slots.get_unchecked_mut(kd.idx as usize);
slot.version ^= 1;
ptrs[i] = MaybeUninit::new(&mut *slot.u.value);
}
i += 1;
}
// Undo temporary unoccupied markings.
for k in &keys[..i] {
let idx = k.data().idx as usize;
unsafe {
self.slots.get_unchecked_mut(idx).version ^= 1;
}
}
if i == N {
// All were valid and disjoint.
Some(unsafe { core::mem::transmute_copy::<_, [&mut V; N]>(&ptrs) })
} else {
None
}
}
/// Returns mutable references to the values corresponding to the given
/// keys. All keys must be valid and disjoint.
///
/// Requires at least stable Rust version 1.51.
///
/// # Safety
///
/// This should only be used if `contains_key(key)` is true for every given
/// key and no two keys are equal. Otherwise it is potentially unsafe.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let ka = sm.insert("butter");
/// let kb = sm.insert("apples");
/// let [a, b] = unsafe { sm.get_disjoint_unchecked_mut([ka, kb]) };
/// std::mem::swap(a, b);
/// assert_eq!(sm[ka], "apples");
/// assert_eq!(sm[kb], "butter");
/// ```
#[cfg(has_min_const_generics)]
pub unsafe fn get_disjoint_unchecked_mut<const N: usize>(
&mut self,
keys: [K; N],
) -> [&mut V; N] {
// Safe, see get_disjoint_mut.
let mut ptrs: [MaybeUninit<*mut V>; N] = MaybeUninit::uninit().assume_init();
for i in 0..N {
ptrs[i] = MaybeUninit::new(self.get_unchecked_mut(keys[i]));
}
core::mem::transmute_copy::<_, [&mut V; N]>(&ptrs)
}
/// An iterator visiting all key-value pairs in arbitrary order. The
/// iterator element type is `(K, &'a V)`.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let k0 = sm.insert(0);
/// let k1 = sm.insert(1);
/// let k2 = sm.insert(2);
///
/// for (k, v) in sm.iter() {
/// println!("key: {:?}, val: {}", k, v);
/// }
/// ```
pub fn iter(&self) -> Iter<K, V> {
Iter {
cur: unsafe { self.slots.get_unchecked(0).u.free.other_end as usize + 1 },
num_left: self.len(),
slots: &self.slots[..],
_k: PhantomData,
}
}
/// An iterator visiting all key-value pairs in arbitrary order, with
/// mutable references to the values. The iterator element type is
/// `(K, &'a mut V)`.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// let mut sm = HopSlotMap::new();
/// let k0 = sm.insert(10);
/// let k1 = sm.insert(20);
/// let k2 = sm.insert(30);
///
/// for (k, v) in sm.iter_mut() {
/// if k != k1 {
/// *v *= -1;
/// }
/// }
///
/// assert_eq!(sm[k0], -10);
/// assert_eq!(sm[k1], 20);
/// assert_eq!(sm[k2], -30);
/// ```
pub fn iter_mut(&mut self) -> IterMut<K, V> {
IterMut {
cur: 0,
num_left: self.len(),
slots: &mut self.slots[..],
_k: PhantomData,
}
}
/// An iterator visiting all keys in arbitrary order. The iterator element
/// type is `K`.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// # use std::collections::HashSet;
/// let mut sm = HopSlotMap::new();
/// let k0 = sm.insert(10);
/// let k1 = sm.insert(20);
/// let k2 = sm.insert(30);
/// let keys: HashSet<_> = sm.keys().collect();
/// let check: HashSet<_> = vec![k0, k1, k2].into_iter().collect();
/// assert_eq!(keys, check);
/// ```
pub fn keys(&self) -> Keys<K, V> {
Keys { inner: self.iter() }
}
/// An iterator visiting all values in arbitrary order. The iterator element
/// type is `&'a V`.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// # use std::collections::HashSet;
/// let mut sm = HopSlotMap::new();
/// let k0 = sm.insert(10);
/// let k1 = sm.insert(20);
/// let k2 = sm.insert(30);
/// let values: HashSet<_> = sm.values().collect();
/// let check: HashSet<_> = vec![&10, &20, &30].into_iter().collect();
/// assert_eq!(values, check);
/// ```
pub fn values(&self) -> Values<K, V> {
Values { inner: self.iter() }
}
/// An iterator visiting all values mutably in arbitrary order. The iterator
/// element type is `&'a mut V`.
///
/// # Examples
///
/// ```
/// # use slotmap::*;
/// # use std::collections::HashSet;
/// let mut sm = HopSlotMap::new();
/// sm.insert(1);
/// sm.insert(2);
/// sm.insert(3);
/// sm.values_mut().for_each(|n| { *n *= 3 });
/// let values: HashSet<_> = sm.into_iter().map(|(_k, v)| v).collect();
/// let check: HashSet<_> = vec![3, 6, 9].into_iter().collect();
/// assert_eq!(values, check);
/// ```
pub fn values_mut(&mut self) -> ValuesMut<K, V> {
ValuesMut {
inner: self.iter_mut(),
}
}
}
impl<K: Key, V> Clone for HopSlotMap<K, V>
where
V: Clone,
{
fn clone(&self) -> Self {
Self {
slots: self.slots.clone(),
..*self
}
}
fn clone_from(&mut self, source: &Self) {
self.slots.clone_from(&source.slots);
self.num_elems = source.num_elems;
}
}
impl<K: Key, V> Default for HopSlotMap<K, V> {
fn default() -> Self {
Self::with_key()
}
}
impl<K: Key, V> Index<K> for HopSlotMap<K, V> {
type Output = V;
fn index(&self, key: K) -> &V {
match self.get(key) {
Some(r) => r,
None => panic!("invalid HopSlotMap key used"),
}
}
}
impl<K: Key, V> IndexMut<K> for HopSlotMap<K, V> {
fn index_mut(&mut self, key: K) -> &mut V {
match self.get_mut(key) {
Some(r) => r,
None => panic!("invalid HopSlotMap key used"),
}
}
}
// Iterators.
/// A draining iterator for [`HopSlotMap`].
///
/// This iterator is created by [`HopSlotMap::drain`].
#[derive(Debug)]
pub struct Drain<'a, K: Key + 'a, V: 'a> {
cur: usize,
sm: &'a mut HopSlotMap<K, V>,
}
/// An iterator that moves key-value pairs out of a [`HopSlotMap`].
///
/// This iterator is created by calling the `into_iter` method on [`HopSlotMap`],
/// provided by the [`IntoIterator`] trait.
#[derive(Debug, Clone)]
pub struct IntoIter<K: Key, V> {
cur: usize,
num_left: usize,
slots: Vec<Slot<V>>,
_k: PhantomData<fn(K) -> K>,
}
/// An iterator over the key-value pairs in a [`HopSlotMap`].
///
/// This iterator is created by [`HopSlotMap::iter`].
#[derive(Debug)]
pub struct Iter<'a, K: Key + 'a, V: 'a> {
cur: usize,
num_left: usize,
slots: &'a [Slot<V>],
_k: PhantomData<fn(K) -> K>,
}
impl<'a, K: 'a + Key, V: 'a> Clone for Iter<'a, K, V> {
fn clone(&self) -> Self {
Iter {
cur: self.cur,
num_left: self.num_left,
slots: self.slots,
_k: self._k.clone(),
}
}
}
/// A mutable iterator over the key-value pairs in a [`HopSlotMap`].
///
/// This iterator is created by [`HopSlotMap::iter_mut`].
#[derive(Debug)]
pub struct IterMut<'a, K: Key + 'a, V: 'a> {
cur: usize,
num_left: usize,
slots: &'a mut [Slot<V>],
_k: PhantomData<fn(K) -> K>,
}
/// An iterator over the keys in a [`HopSlotMap`].
///
/// This iterator is created by [`HopSlotMap::keys`].
#[derive(Debug)]
pub struct Keys<'a, K: Key + 'a, V: 'a> {
inner: Iter<'a, K, V>,
}
impl<'a, K: 'a + Key, V: 'a> Clone for Keys<'a, K, V> {
fn clone(&self) -> Self {
Keys {
inner: self.inner.clone(),
}
}
}
/// An iterator over the values in a [`HopSlotMap`].
///
/// This iterator is created by [`HopSlotMap::values`].
#[derive(Debug)]
pub struct Values<'a, K: Key + 'a, V: 'a> {
inner: Iter<'a, K, V>,
}
impl<'a, K: 'a + Key, V: 'a> Clone for Values<'a, K, V> {
fn clone(&self) -> Self {
Values {
inner: self.inner.clone(),
}
}
}
/// A mutable iterator over the values in a [`HopSlotMap`].
///
/// This iterator is created by [`HopSlotMap::values_mut`].
#[derive(Debug)]
pub struct ValuesMut<'a, K: Key + 'a, V: 'a> {
inner: IterMut<'a, K, V>,
}
impl<'a, K: Key, V> Iterator for Drain<'a, K, V> {
type Item = (K, V);
fn next(&mut self) -> Option<(K, V)> {
// All unchecked indices are safe due to the invariants of the freelist
// and that self.sm.len() guarantees there is another element.
if self.sm.len() == 0 {
return None;
}
// Skip ahead to next element. Must do this before removing.
let idx = self.cur;
self.cur = match self.sm.slots.get(idx + 1).map(|s| s.get()) {
Some(Occupied(_)) => idx + 1,
Some(Vacant(free)) => free.other_end as usize + 1,
None => 0,
};
let key = KeyData::new(idx as u32, unsafe { self.sm.slots.get_unchecked(idx).version });
Some((key.into(), unsafe { self.sm.remove_from_slot(idx) }))
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.sm.len(), Some(self.sm.len()))
}
}
impl<'a, K: Key, V> Drop for Drain<'a, K, V> {
fn drop(&mut self) {
self.for_each(|_drop| {});
}
}
impl<K: Key, V> Iterator for IntoIter<K, V> {
type Item = (K, V);
fn next(&mut self) -> Option<(K, V)> {
if self.cur >= self.slots.len() {
return None;
}
let idx = match self.slots[self.cur].get() {
Occupied(_) => self.cur,
Vacant(free) => {
// Skip block of contiguous vacant slots.
let idx = free.other_end as usize + 1;
if idx >= self.slots.len() {
return None;
}
idx
},
};
self.cur = idx + 1;
self.num_left -= 1;
let slot = &mut self.slots[idx];
let key = KeyData::new(idx as u32, slot.version).into();
slot.version = 0; // Prevent dropping after extracting the value.
Some((key, unsafe { ManuallyDrop::take(&mut slot.u.value) }))
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.num_left, Some(self.num_left))
}
}
impl<'a, K: Key, V> Iterator for Iter<'a, K, V> {
type Item = (K, &'a V);
fn next(&mut self) -> Option<(K, &'a V)> {
// All unchecked indices are safe due to the invariants of the freelist
// and that num_left guarantees there is another element.
if self.num_left == 0 {
return None;
}
self.num_left -= 1;
let idx = match unsafe { self.slots.get_unchecked(self.cur).get() } {
Occupied(_) => self.cur,
Vacant(free) => free.other_end as usize + 1,
};
self.cur = idx + 1;
let slot = unsafe { self.slots.get_unchecked(idx) };
let key = KeyData::new(idx as u32, slot.version).into();
Some((key, unsafe { &*slot.u.value }))
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.num_left, Some(self.num_left))
}
}
impl<'a, K: Key, V> Iterator for IterMut<'a, K, V> {
type Item = (K, &'a mut V);
fn next(&mut self) -> Option<(K, &'a mut V)> {
if self.cur >= self.slots.len() {
return None;
}
let idx = match self.slots[self.cur].get() {
Occupied(_) => self.cur,
Vacant(free) => {
// Skip block of contiguous vacant slots.
let idx = free.other_end as usize + 1;
if idx >= self.slots.len() {
return None;
}
idx
},
};
self.cur = idx + 1;
self.num_left -= 1;
// Unsafe necessary because Rust can't deduce that we won't
// return multiple references to the same value.
let slot = &mut self.slots[idx];
let version = slot.version;
let value_ref = unsafe {
let ptr: *mut V = &mut *slot.u.value;
&mut *ptr
};
Some((KeyData::new(idx as u32, version).into(), value_ref))
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.num_left, Some(self.num_left))
}
}
impl<'a, K: Key, V> Iterator for Keys<'a, K, V> {
type Item = K;
fn next(&mut self) -> Option<K> {
self.inner.next().map(|(key, _)| key)
}
fn size_hint(&self) -> (usize, Option<usize>) {
self.inner.size_hint()
}
}
impl<'a, K: Key, V> Iterator for Values<'a, K, V> {
type Item = &'a V;
fn next(&mut self) -> Option<&'a V> {
self.inner.next().map(|(_, value)| value)
}
fn size_hint(&self) -> (usize, Option<usize>) {
self.inner.size_hint()
}
}
impl<'a, K: Key, V> Iterator for ValuesMut<'a, K, V> {
type Item = &'a mut V;
fn next(&mut self) -> Option<&'a mut V> {
self.inner.next().map(|(_, value)| value)
}
fn size_hint(&self) -> (usize, Option<usize>) {
self.inner.size_hint()
}
}
impl<'a, K: Key, V> IntoIterator for &'a HopSlotMap<K, V> {
type Item = (K, &'a V);
type IntoIter = Iter<'a, K, V>;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
impl<'a, K: Key, V> IntoIterator for &'a mut HopSlotMap<K, V> {
type Item = (K, &'a mut V);
type IntoIter = IterMut<'a, K, V>;
fn into_iter(self) -> Self::IntoIter {
self.iter_mut()
}
}
impl<K: Key, V> IntoIterator for HopSlotMap<K, V> {
type Item = (K, V);
type IntoIter = IntoIter<K, V>;
fn into_iter(self) -> Self::IntoIter {
IntoIter {
cur: 0,
num_left: self.len(),
slots: self.slots,
_k: PhantomData,
}
}
}
impl<'a, K: Key, V> FusedIterator for Iter<'a, K, V> {}
impl<'a, K: Key, V> FusedIterator for IterMut<'a, K, V> {}
impl<'a, K: Key, V> FusedIterator for Keys<'a, K, V> {}
impl<'a, K: Key, V> FusedIterator for Values<'a, K, V> {}
impl<'a, K: Key, V> FusedIterator for ValuesMut<'a, K, V> {}
impl<'a, K: Key, V> FusedIterator for Drain<'a, K, V> {}
impl<K: Key, V> FusedIterator for IntoIter<K, V> {}
impl<'a, K: Key, V> ExactSizeIterator for Iter<'a, K, V> {}
impl<'a, K: Key, V> ExactSizeIterator for IterMut<'a, K, V> {}
impl<'a, K: Key, V> ExactSizeIterator for Keys<'a, K, V> {}
impl<'a, K: Key, V> ExactSizeIterator for Values<'a, K, V> {}
impl<'a, K: Key, V> ExactSizeIterator for ValuesMut<'a, K, V> {}
impl<'a, K: Key, V> ExactSizeIterator for Drain<'a, K, V> {}
impl<K: Key, V> ExactSizeIterator for IntoIter<K, V> {}
// Serialization with serde.
#[cfg(feature = "serde")]
mod serialize {
use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
use super::*;
#[derive(Serialize, Deserialize)]
struct SerdeSlot<T> {
value: Option<T>,
version: u32,
}
impl<T: Serialize> Serialize for Slot<T> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let serde_slot = SerdeSlot {
version: self.version,
value: match self.get() {
Occupied(value) => Some(value),
Vacant(_) => None,
},
};
serde_slot.serialize(serializer)
}
}
impl<'de, T> Deserialize<'de> for Slot<T>
where
T: Deserialize<'de>,
{
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let serde_slot: SerdeSlot<T> = Deserialize::deserialize(deserializer)?;
let occupied = serde_slot.version % 2 == 1;
if occupied ^ serde_slot.value.is_some() {
return Err(de::Error::custom(&"inconsistent occupation in Slot"));
}
Ok(Self {
u: match serde_slot.value {
Some(value) => SlotUnion {
value: ManuallyDrop::new(value),
},
None => SlotUnion {
free: FreeListEntry {
next: 0,
prev: 0,
other_end: 0,
},
},
},
version: serde_slot.version,
})
}
}
impl<K: Key, V: Serialize> Serialize for HopSlotMap<K, V> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
self.slots.serialize(serializer)
}
}
impl<'de, K: Key, V: Deserialize<'de>> Deserialize<'de> for HopSlotMap<K, V> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let mut slots: Vec<Slot<V>> = Deserialize::deserialize(deserializer)?;
if slots.len() >= u32::max_value() as usize {
return Err(de::Error::custom(&"too many slots"));
}
// Ensure the first slot exists and is empty for the sentinel.
if slots.get(0).map_or(true, |slot| slot.version % 2 == 1) {
return Err(de::Error::custom(&"first slot not empty"));
}
slots[0].u.free = FreeListEntry {
next: 0,
prev: 0,
other_end: 0,
};
// We have our slots, rebuild freelist.
let mut num_elems = 0;
let mut prev = 0;
let mut i = 0;
while i < slots.len() {
// i is the start of a contiguous block of vacant slots.
let front = i;
while i < slots.len() && !slots[i].occupied() {
i += 1;
}
let back = i - 1;
// Update freelist.
unsafe {
slots[back].u.free.other_end = front as u32;
slots[prev].u.free.next = front as u32;
slots[front].u.free = FreeListEntry {
next: 0,
prev: prev as u32,
other_end: back as u32,
};
}
prev = front;
// Skip occupied slots.
while i < slots.len() && slots[i].occupied() {
num_elems += 1;
i += 1;
}
}
Ok(Self {
num_elems,
slots,
_k: PhantomData,
})
}
}
}
#[cfg(test)]
mod tests {
use std::collections::{HashMap, HashSet};
use quickcheck::quickcheck;
use super::*;
#[derive(Clone)]
struct CountDrop<'a>(&'a std::cell::RefCell<usize>);
impl<'a> Drop for CountDrop<'a> {
fn drop(&mut self) {
*self.0.borrow_mut() += 1;
}
}
#[cfg(all(nightly, feature = "unstable"))]
#[test]
fn check_drops() {
let drops = std::cell::RefCell::new(0usize);
{
let mut clone = {
// Insert 1000 items.
let mut sm = HopSlotMap::new();
let mut sm_keys = Vec::new();
for _ in 0..1000 {
sm_keys.push(sm.insert(CountDrop(&drops)));
}
// Remove even keys.
for i in (0..1000).filter(|i| i % 2 == 0) {
sm.remove(sm_keys[i]);
}
// Should only have dropped 500 so far.
assert_eq!(*drops.borrow(), 500);
// Let's clone ourselves and then die.
sm.clone()
};
// Now all original items should have been dropped exactly once.
assert_eq!(*drops.borrow(), 1000);
// Reuse some empty slots.
for _ in 0..250 {
clone.insert(CountDrop(&drops));
}
}
// 1000 + 750 drops in total should have happened.
assert_eq!(*drops.borrow(), 1750);
}
#[cfg(all(nightly, feature = "unstable"))]
#[test]
fn disjoint() {
// Intended to be run with miri to find any potential UB.
let mut sm = HopSlotMap::new();
// Some churn.
for i in 0..20usize {
sm.insert(i);
}
sm.retain(|_, i| *i % 2 == 0);
let keys: Vec<_> = sm.keys().collect();
for i in 0..keys.len() {
for j in 0..keys.len() {
if let Some([r0, r1]) = sm.get_disjoint_mut([keys[i], keys[j]]) {
*r0 ^= *r1;
*r1 = r1.wrapping_add(*r0);
} else {
assert!(i == j);
}
}
}
for i in 0..keys.len() {
for j in 0..keys.len() {
for k in 0..keys.len() {
if let Some([r0, r1, r2]) = sm.get_disjoint_mut([keys[i], keys[j], keys[k]]) {
*r0 ^= *r1;
*r0 = r0.wrapping_add(*r2);
*r1 ^= *r0;
*r1 = r1.wrapping_add(*r2);
*r2 ^= *r0;
*r2 = r2.wrapping_add(*r1);
} else {
assert!(i == j || j == k || i == k);
}
}
}
}
}
quickcheck! {
fn qc_slotmap_equiv_hashmap(operations: Vec<(u8, u32)>) -> bool {
let mut hm = HashMap::new();
let mut hm_keys = Vec::new();
let mut unique_key = 0u32;
let mut sm = HopSlotMap::new();
let mut sm_keys = Vec::new();
#[cfg(not(feature = "serde"))]
let num_ops = 3;
#[cfg(feature = "serde")]
let num_ops = 4;
for (op, val) in operations {
match op % num_ops {
// Insert.
0 => {
hm.insert(unique_key, val);
hm_keys.push(unique_key);
unique_key += 1;
sm_keys.push(sm.insert(val));
}
// Delete.
1 => {
// 10% of the time test clear.
if val % 10 == 0 {
let hmvals: HashSet<_> = hm.drain().map(|(_, v)| v).collect();
let smvals: HashSet<_> = sm.drain().map(|(_, v)| v).collect();
if hmvals != smvals {
return false;
}
}
if hm_keys.is_empty() { continue; }
let idx = val as usize % hm_keys.len();
if hm.remove(&hm_keys[idx]) != sm.remove(sm_keys[idx]) {
return false;
}
}
// Access.
2 => {
if hm_keys.is_empty() { continue; }
let idx = val as usize % hm_keys.len();
let (hm_key, sm_key) = (&hm_keys[idx], sm_keys[idx]);
if hm.contains_key(hm_key) != sm.contains_key(sm_key) ||
hm.get(hm_key) != sm.get(sm_key) {
return false;
}
}
// Serde round-trip.
#[cfg(feature = "serde")]
3 => {
let ser = serde_json::to_string(&sm).unwrap();
sm = serde_json::from_str(&ser).unwrap();
}
_ => unreachable!(),
}
}
let mut smv: Vec<_> = sm.values().collect();
let mut hmv: Vec<_> = hm.values().collect();
smv.sort();
hmv.sort();
smv == hmv
}
}
#[cfg(feature = "serde")]
#[test]
fn slotmap_serde() {
let mut sm = HopSlotMap::new();
// Self-referential structure.
let first = sm.insert_with_key(|k| (k, 23i32));
let second = sm.insert((first, 42));
// Make some empty slots.
let empties = vec![sm.insert((first, 0)), sm.insert((first, 0))];
empties.iter().for_each(|k| {
sm.remove(*k);
});
let third = sm.insert((second, 0));
sm[first].0 = third;
let ser = serde_json::to_string(&sm).unwrap();
let de: HopSlotMap<DefaultKey, (DefaultKey, i32)> = serde_json::from_str(&ser).unwrap();
assert_eq!(de.len(), sm.len());
let mut smkv: Vec<_> = sm.iter().collect();
let mut dekv: Vec<_> = de.iter().collect();
smkv.sort();
dekv.sort();
assert_eq!(smkv, dekv);
}
#[cfg(feature = "serde")]
#[test]
fn slotmap_serde_freelist() {
let mut sm = HopSlotMap::new();
let k = sm.insert(5i32);
sm.remove(k);
let ser = serde_json::to_string(&sm).unwrap();
let mut de: HopSlotMap<DefaultKey, i32> = serde_json::from_str(&ser).unwrap();
de.insert(0);
de.insert(1);
de.insert(2);
assert_eq!(de.len(), 3);
}
}