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
/*!
[![](https://docs.rs/generational-arena/badge.svg)](https://docs.rs/generational-arena/)
[![](https://img.shields.io/crates/v/generational-arena.svg)](https://crates.io/crates/generational-arena)
[![](https://img.shields.io/crates/d/generational-arena.svg)](https://crates.io/crates/generational-arena)
[![](https://github.com/fitzgen/generational-arena/actions/workflows/rust.yml/badge.svg)](https://github.com/fitzgen/generational-arena/actions/workflows/rust.yml)
A safe arena allocator that allows deletion without suffering from [the ABA
problem](https://en.wikipedia.org/wiki/ABA_problem) by using generational
indices.
Inspired by [Catherine West's closing keynote at RustConf
2018](https://www.youtube.com/watch?v=aKLntZcp27M), where these ideas (and many
more!) were presented in the context of an Entity-Component-System for games
programming.
## What? Why?
Imagine you are working with a graph and you want to add and delete individual
nodes at a time, or you are writing a game and its world consists of many
inter-referencing objects with dynamic lifetimes that depend on user
input. These are situations where matching Rust's ownership and lifetime rules
can get tricky.
It doesn't make sense to use shared ownership with interior mutability (i.e.
`Rc<RefCell<T>>` or `Arc<Mutex<T>>`) nor borrowed references (ie `&'a T` or `&'a
mut T`) for structures. The cycles rule out reference counted types, and the
required shared mutability rules out borrows. Furthermore, lifetimes are dynamic
and don't follow the borrowed-data-outlives-the-borrower discipline.
In these situations, it is tempting to store objects in a `Vec<T>` and have them
reference each other via their indices. No more borrow checker or ownership
problems! Often, this solution is good enough.
However, now we can't delete individual items from that `Vec<T>` when we no
longer need them, because we end up either
* messing up the indices of every element that follows the deleted one, or
* suffering from the [ABA
problem](https://en.wikipedia.org/wiki/ABA_problem). To elaborate further, if
we tried to replace the `Vec<T>` with a `Vec<Option<T>>`, and delete an
element by setting it to `None`, then we create the possibility for this buggy
sequence:
* `obj1` references `obj2` at index `i`
* someone else deletes `obj2` from index `i`, setting that element to `None`
* a third thing allocates `obj3`, which ends up at index `i`, because the
element at that index is `None` and therefore available for allocation
* `obj1` attempts to get `obj2` at index `i`, but incorrectly is given
`obj3`, when instead the get should fail.
By introducing a monotonically increasing generation counter to the collection,
associating each element in the collection with the generation when it was
inserted, and getting elements from the collection with the *pair* of index and
the generation at the time when the element was inserted, then we can solve the
aforementioned ABA problem. When indexing into the collection, if the index
pair's generation does not match the generation of the element at that index,
then the operation fails.
## Features
* Zero `unsafe`
* Well tested, including quickchecks
* `no_std` compatibility
* All the trait implementations you expect: `IntoIterator`, `FromIterator`,
`Extend`, etc...
## Usage
First, add `generational-arena` to your `Cargo.toml`:
```toml
[dependencies]
generational-arena = "0.2"
```
Then, import the crate and use the
[`generational_arena::Arena`](./struct.Arena.html) type!
```rust
extern crate generational_arena;
use generational_arena::Arena;
let mut arena = Arena::new();
// Insert some elements into the arena.
let rza = arena.insert("Robert Fitzgerald Diggs");
let gza = arena.insert("Gary Grice");
let bill = arena.insert("Bill Gates");
// Inserted elements can be accessed infallibly via indexing (and missing
// entries will panic).
assert_eq!(arena[rza], "Robert Fitzgerald Diggs");
// Alternatively, the `get` and `get_mut` methods provide fallible lookup.
if let Some(genius) = arena.get(gza) {
println!("The gza gza genius: {}", genius);
}
if let Some(val) = arena.get_mut(bill) {
*val = "Bill Gates doesn't belong in this set...";
}
// We can remove elements.
arena.remove(bill);
// Insert a new one.
let murray = arena.insert("Bill Murray");
// The arena does not contain `bill` anymore, but it does contain `murray`, even
// though they are almost certainly at the same index within the arena in
// practice. Ambiguities are resolved with an associated generation tag.
assert!(!arena.contains(bill));
assert!(arena.contains(murray));
// Iterate over everything inside the arena.
for (idx, value) in &arena {
println!("{:?} is at {:?}", value, idx);
}
```
## `no_std`
To enable `no_std` compatibility, disable the on-by-default "std" feature.
```toml
[dependencies]
generational-arena = { version = "0.2", default-features = false }
```
### Serialization and Deserialization with [`serde`](https://crates.io/crates/serde)
To enable serialization/deserialization support, enable the "serde" feature.
```toml
[dependencies]
generational-arena = { version = "0.2", features = ["serde"] }
```
*/
#![forbid(unsafe_code, missing_docs, missing_debug_implementations)]
#![no_std]
cfg_if::cfg_if! {
if #[cfg(feature = "std")] {
extern crate std;
use std::vec::{self, Vec};
} else {
extern crate alloc;
use alloc::vec::{self, Vec};
}
}
use core::cmp;
use core::iter::{self, Extend, FromIterator, FusedIterator};
use core::mem;
use core::ops;
use core::slice;
#[cfg(feature = "serde")]
mod serde_impl;
/// The `Arena` allows inserting and removing elements that are referred to by
/// `Index`.
///
/// [See the module-level documentation for example usage and motivation.](./index.html)
#[derive(Clone, Debug)]
pub struct Arena<T> {
items: Vec<Entry<T>>,
generation: u64,
free_list_head: Option<usize>,
len: usize,
}
#[derive(Clone, Debug)]
enum Entry<T> {
Free { next_free: Option<usize> },
Occupied { generation: u64, value: T },
}
/// An index (and generation) into an `Arena`.
///
/// To get an `Index`, insert an element into an `Arena`, and the `Index` for
/// that element will be returned.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx = arena.insert(123);
/// assert_eq!(arena[idx], 123);
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Index {
index: usize,
generation: u64,
}
impl Index {
/// Create a new `Index` from its raw parts.
///
/// The parts must have been returned from an earlier call to
/// `into_raw_parts`.
///
/// Providing arbitrary values will lead to malformed indices and ultimately
/// panics.
pub fn from_raw_parts(a: usize, b: u64) -> Index {
Index {
index: a,
generation: b,
}
}
/// Convert this `Index` into its raw parts.
///
/// This niche method is useful for converting an `Index` into another
/// identifier type. Usually, you should prefer a newtype wrapper around
/// `Index` like `pub struct MyIdentifier(Index);`. However, for external
/// types whose definition you can't customize, but which you can construct
/// instances of, this method can be useful.
pub fn into_raw_parts(self) -> (usize, u64) {
(self.index, self.generation)
}
}
const DEFAULT_CAPACITY: usize = 4;
impl<T> Default for Arena<T> {
fn default() -> Arena<T> {
Arena::new()
}
}
impl<T> Arena<T> {
/// Constructs a new, empty `Arena`.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::<usize>::new();
/// # let _ = arena;
/// ```
pub fn new() -> Arena<T> {
Arena::with_capacity(DEFAULT_CAPACITY)
}
/// Constructs a new, empty `Arena<T>` with the specified capacity.
///
/// The `Arena<T>` will be able to hold `n` elements without further allocation.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::with_capacity(10);
///
/// // These insertions will not require further allocation.
/// for i in 0..10 {
/// assert!(arena.try_insert(i).is_ok());
/// }
///
/// // But now we are at capacity, and there is no more room.
/// assert!(arena.try_insert(99).is_err());
/// ```
pub fn with_capacity(n: usize) -> Arena<T> {
let n = cmp::max(n, 1);
let mut arena = Arena {
items: Vec::new(),
generation: 0,
free_list_head: None,
len: 0,
};
arena.reserve(n);
arena
}
/// Clear all the items inside the arena, but keep its allocation.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::with_capacity(1);
/// arena.insert(42);
/// arena.insert(43);
///
/// arena.clear();
///
/// assert_eq!(arena.capacity(), 2);
/// ```
pub fn clear(&mut self) {
self.items.clear();
let end = self.items.capacity();
self.items.extend((0..end).map(|i| {
if i == end - 1 {
Entry::Free { next_free: None }
} else {
Entry::Free {
next_free: Some(i + 1),
}
}
}));
if !self.is_empty() {
// Increment generation, but if there are no elements, do nothing to
// avoid unnecessary incrementing generation.
self.generation += 1;
}
self.free_list_head = Some(0);
self.len = 0;
}
/// Attempts to insert `value` into the arena using existing capacity.
///
/// This method will never allocate new capacity in the arena.
///
/// If insertion succeeds, then the `value`'s index is returned. If
/// insertion fails, then `Err(value)` is returned to give ownership of
/// `value` back to the caller.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
///
/// match arena.try_insert(42) {
/// Ok(idx) => {
/// // Insertion succeeded.
/// assert_eq!(arena[idx], 42);
/// }
/// Err(x) => {
/// // Insertion failed.
/// assert_eq!(x, 42);
/// }
/// };
/// ```
#[inline]
pub fn try_insert(&mut self, value: T) -> Result<Index, T> {
match self.try_alloc_next_index() {
None => Err(value),
Some(index) => {
self.items[index.index] = Entry::Occupied {
generation: self.generation,
value,
};
Ok(index)
},
}
}
/// Attempts to insert the value returned by `create` into the arena using existing capacity.
/// `create` is called with the new value's associated index, allowing values that know their own index.
///
/// This method will never allocate new capacity in the arena.
///
/// If insertion succeeds, then the new index is returned. If
/// insertion fails, then `Err(create)` is returned to give ownership of
/// `create` back to the caller.
///
/// # Examples
///
/// ```
/// use generational_arena::{Arena, Index};
///
/// let mut arena = Arena::new();
///
/// match arena.try_insert_with(|idx| (42, idx)) {
/// Ok(idx) => {
/// // Insertion succeeded.
/// assert_eq!(arena[idx].0, 42);
/// assert_eq!(arena[idx].1, idx);
/// }
/// Err(x) => {
/// // Insertion failed.
/// }
/// };
/// ```
#[inline]
pub fn try_insert_with<F: FnOnce(Index) -> T>(&mut self, create: F) -> Result<Index, F> {
match self.try_alloc_next_index() {
None => Err(create),
Some(index) => {
self.items[index.index] = Entry::Occupied {
generation: self.generation,
value: create(index),
};
Ok(index)
},
}
}
#[inline]
fn try_alloc_next_index(&mut self) -> Option<Index> {
match self.free_list_head {
None => None,
Some(i) => match self.items[i] {
Entry::Occupied { .. } => panic!("corrupt free list"),
Entry::Free { next_free } => {
self.free_list_head = next_free;
self.len += 1;
Some(Index {
index: i,
generation: self.generation,
})
}
}
}
}
/// Insert `value` into the arena, allocating more capacity if necessary.
///
/// The `value`'s associated index in the arena is returned.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
///
/// let idx = arena.insert(42);
/// assert_eq!(arena[idx], 42);
/// ```
#[inline]
pub fn insert(&mut self, value: T) -> Index {
match self.try_insert(value) {
Ok(i) => i,
Err(value) => self.insert_slow_path(value),
}
}
/// Insert the value returned by `create` into the arena, allocating more capacity if necessary.
/// `create` is called with the new value's associated index, allowing values that know their own index.
///
/// The new value's associated index in the arena is returned.
///
/// # Examples
///
/// ```
/// use generational_arena::{Arena, Index};
///
/// let mut arena = Arena::new();
///
/// let idx = arena.insert_with(|idx| (42, idx));
/// assert_eq!(arena[idx].0, 42);
/// assert_eq!(arena[idx].1, idx);
/// ```
#[inline]
pub fn insert_with(&mut self, create: impl FnOnce(Index) -> T) -> Index {
match self.try_insert_with(create) {
Ok(i) => i,
Err(create) => self.insert_with_slow_path(create),
}
}
#[inline(never)]
fn insert_slow_path(&mut self, value: T) -> Index {
let len = if self.capacity() == 0 {
// `drain()` sets the capacity to 0 and if the capacity is 0, the
// next `try_insert() `will refer to an out-of-range index because
// the next `reserve()` does not add element, resulting in a panic.
// So ensure that `self` have at least 1 capacity here.
//
// Ideally, this problem should be handled within `drain()`,but
// this problem cannot be handled within `drain()` because `drain()`
// returns an iterator that borrows `self` mutably.
1
} else {
self.items.len()
};
self.reserve(len);
self.try_insert(value)
.map_err(|_| ())
.expect("inserting will always succeed after reserving additional space")
}
#[inline(never)]
fn insert_with_slow_path(&mut self, create: impl FnOnce(Index) -> T) -> Index {
let len = self.items.len();
self.reserve(len);
self.try_insert_with(create)
.map_err(|_| ())
.expect("inserting will always succeed after reserving additional space")
}
/// Remove the element at index `i` from the arena.
///
/// If the element at index `i` is still in the arena, then it is
/// returned. If it is not in the arena, then `None` is returned.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx = arena.insert(42);
///
/// assert_eq!(arena.remove(idx), Some(42));
/// assert_eq!(arena.remove(idx), None);
/// ```
pub fn remove(&mut self, i: Index) -> Option<T> {
if i.index >= self.items.len() {
return None;
}
match self.items[i.index] {
Entry::Occupied { generation, .. } if i.generation == generation => {
let entry = mem::replace(
&mut self.items[i.index],
Entry::Free { next_free: self.free_list_head },
);
self.generation += 1;
self.free_list_head = Some(i.index);
self.len -= 1;
match entry {
Entry::Occupied { generation: _, value } => Some(value),
_ => unreachable!(),
}
}
_ => None,
}
}
/// Retains only the elements specified by the predicate.
///
/// In other words, remove all indices such that `predicate(index, &value)` returns `false`.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut crew = Arena::new();
/// crew.extend(&["Jim Hawkins", "John Silver", "Alexander Smollett", "Israel Hands"]);
/// let pirates = ["John Silver", "Israel Hands"]; // too dangerous to keep them around
/// crew.retain(|_index, member| !pirates.contains(member));
/// let mut crew_members = crew.iter().map(|(_, member)| **member);
/// assert_eq!(crew_members.next(), Some("Jim Hawkins"));
/// assert_eq!(crew_members.next(), Some("Alexander Smollett"));
/// assert!(crew_members.next().is_none());
/// ```
pub fn retain(&mut self, mut predicate: impl FnMut(Index, &mut T) -> bool) {
for i in 0..self.capacity() {
let remove = match &mut self.items[i] {
Entry::Occupied { generation, value } => {
let index = Index {
index: i,
generation: *generation,
};
if predicate(index, value) {
None
} else {
Some(index)
}
}
_ => None,
};
if let Some(index) = remove {
self.remove(index);
}
}
}
/// Is the element at index `i` in the arena?
///
/// Returns `true` if the element at `i` is in the arena, `false` otherwise.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx = arena.insert(42);
///
/// assert!(arena.contains(idx));
/// arena.remove(idx);
/// assert!(!arena.contains(idx));
/// ```
pub fn contains(&self, i: Index) -> bool {
self.get(i).is_some()
}
/// Get a shared reference to the element at index `i` if it is in the
/// arena.
///
/// If the element at index `i` is not in the arena, then `None` is returned.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx = arena.insert(42);
///
/// assert_eq!(arena.get(idx), Some(&42));
/// arena.remove(idx);
/// assert!(arena.get(idx).is_none());
/// ```
pub fn get(&self, i: Index) -> Option<&T> {
match self.items.get(i.index) {
Some(Entry::Occupied {
generation,
value,
}) if *generation == i.generation => Some(value),
_ => None,
}
}
/// Get an exclusive reference to the element at index `i` if it is in the
/// arena.
///
/// If the element at index `i` is not in the arena, then `None` is returned.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx = arena.insert(42);
///
/// *arena.get_mut(idx).unwrap() += 1;
/// assert_eq!(arena.remove(idx), Some(43));
/// assert!(arena.get_mut(idx).is_none());
/// ```
pub fn get_mut(&mut self, i: Index) -> Option<&mut T> {
match self.items.get_mut(i.index) {
Some(Entry::Occupied {
generation,
value,
}) if *generation == i.generation => Some(value),
_ => None,
}
}
/// Get a pair of exclusive references to the elements at index `i1` and `i2` if it is in the
/// arena.
///
/// If the element at index `i1` or `i2` is not in the arena, then `None` is returned for this
/// element.
///
/// # Panics
///
/// Panics if `i1` and `i2` are pointing to the same item of the arena.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx1 = arena.insert(0);
/// let idx2 = arena.insert(1);
///
/// {
/// let (item1, item2) = arena.get2_mut(idx1, idx2);
///
/// *item1.unwrap() = 3;
/// *item2.unwrap() = 4;
/// }
///
/// assert_eq!(arena[idx1], 3);
/// assert_eq!(arena[idx2], 4);
/// ```
pub fn get2_mut(&mut self, i1: Index, i2: Index) -> (Option<&mut T>, Option<&mut T>) {
let len = self.items.len();
if i1.index == i2.index {
assert!(i1.generation != i2.generation);
if i1.generation > i2.generation {
return (self.get_mut(i1), None);
}
return (None, self.get_mut(i2));
}
if i1.index >= len {
return (None, self.get_mut(i2));
} else if i2.index >= len {
return (self.get_mut(i1), None);
}
let (raw_item1, raw_item2) = {
let (xs, ys) = self.items.split_at_mut(cmp::max(i1.index, i2.index));
if i1.index < i2.index {
(&mut xs[i1.index], &mut ys[0])
} else {
(&mut ys[0], &mut xs[i2.index])
}
};
let item1 = match raw_item1 {
Entry::Occupied {
generation,
value,
} if *generation == i1.generation => Some(value),
_ => None,
};
let item2 = match raw_item2 {
Entry::Occupied {
generation,
value,
} if *generation == i2.generation => Some(value),
_ => None,
};
(item1, item2)
}
/// Get the length of this arena.
///
/// The length is the number of elements the arena holds.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// assert_eq!(arena.len(), 0);
///
/// let idx = arena.insert(42);
/// assert_eq!(arena.len(), 1);
///
/// let _ = arena.insert(0);
/// assert_eq!(arena.len(), 2);
///
/// assert_eq!(arena.remove(idx), Some(42));
/// assert_eq!(arena.len(), 1);
/// ```
pub fn len(&self) -> usize {
self.len
}
/// Returns true if the arena contains no elements
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// assert!(arena.is_empty());
///
/// let idx = arena.insert(42);
/// assert!(!arena.is_empty());
///
/// assert_eq!(arena.remove(idx), Some(42));
/// assert!(arena.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
self.len == 0
}
/// Get the capacity of this arena.
///
/// The capacity is the maximum number of elements the arena can hold
/// without further allocation, including however many it currently
/// contains.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::with_capacity(10);
/// assert_eq!(arena.capacity(), 10);
///
/// // `try_insert` does not allocate new capacity.
/// for i in 0..10 {
/// assert!(arena.try_insert(1).is_ok());
/// assert_eq!(arena.capacity(), 10);
/// }
///
/// // But `insert` will if the arena is already at capacity.
/// arena.insert(0);
/// assert!(arena.capacity() > 10);
/// ```
pub fn capacity(&self) -> usize {
self.items.len()
}
/// Allocate space for `additional_capacity` more elements in the arena.
///
/// # Panics
///
/// Panics if this causes the capacity to overflow.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::with_capacity(10);
/// arena.reserve(5);
/// assert_eq!(arena.capacity(), 15);
/// # let _: Arena<usize> = arena;
/// ```
pub fn reserve(&mut self, additional_capacity: usize) {
let start = self.items.len();
let end = self.items.len() + additional_capacity;
let old_head = self.free_list_head;
self.items.reserve_exact(additional_capacity);
self.items.extend((start..end).map(|i| {
if i == end - 1 {
Entry::Free {
next_free: old_head,
}
} else {
Entry::Free {
next_free: Some(i + 1),
}
}
}));
self.free_list_head = Some(start);
}
/// Iterate over shared references to the elements in this arena.
///
/// Yields pairs of `(Index, &T)` items.
///
/// Order of iteration is not defined.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// for i in 0..10 {
/// arena.insert(i * i);
/// }
///
/// for (idx, value) in arena.iter() {
/// println!("{} is at index {:?}", value, idx);
/// }
/// ```
pub fn iter(&self) -> Iter<T> {
Iter {
len: self.len,
inner: self.items.iter().enumerate(),
}
}
/// Iterate over exclusive references to the elements in this arena.
///
/// Yields pairs of `(Index, &mut T)` items.
///
/// Order of iteration is not defined.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// for i in 0..10 {
/// arena.insert(i * i);
/// }
///
/// for (_idx, value) in arena.iter_mut() {
/// *value += 5;
/// }
/// ```
pub fn iter_mut(&mut self) -> IterMut<T> {
IterMut {
len: self.len,
inner: self.items.iter_mut().enumerate(),
}
}
/// Iterate over elements of the arena and remove them.
///
/// Yields pairs of `(Index, T)` items.
///
/// Order of iteration is not defined.
///
/// Note: All elements are removed even if the iterator is only partially consumed or not consumed at all.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx_1 = arena.insert("hello");
/// let idx_2 = arena.insert("world");
///
/// assert!(arena.get(idx_1).is_some());
/// assert!(arena.get(idx_2).is_some());
/// for (idx, value) in arena.drain() {
/// assert!((idx == idx_1 && value == "hello") || (idx == idx_2 && value == "world"));
/// }
/// assert!(arena.get(idx_1).is_none());
/// assert!(arena.get(idx_2).is_none());
/// ```
pub fn drain(&mut self) -> Drain<T> {
let old_len = self.len;
if !self.is_empty() {
// Increment generation, but if there are no elements, do nothing to
// avoid unnecessary incrementing generation.
self.generation += 1;
}
self.free_list_head = None;
self.len = 0;
Drain {
len: old_len,
inner: self.items.drain(..).enumerate(),
}
}
/// Given an i of `usize` without a generation, get a shared reference
/// to the element and the matching `Index` of the entry behind `i`.
///
/// This method is useful when you know there might be an element at the
/// position i, but don't know its generation or precise Index.
///
/// Use cases include using indexing such as Hierarchical BitMap Indexing or
/// other kinds of bit-efficient indexing.
///
/// You should use the `get` method instead most of the time.
pub fn get_unknown_gen(&self, i: usize) -> Option<(&T, Index)> {
match self.items.get(i) {
Some(Entry::Occupied {
generation,
value,
}) => Some((value, Index { generation: *generation, index: i})),
_ => None,
}
}
/// Given an i of `usize` without a generation, get an exclusive reference
/// to the element and the matching `Index` of the entry behind `i`.
///
/// This method is useful when you know there might be an element at the
/// position i, but don't know its generation or precise Index.
///
/// Use cases include using indexing such as Hierarchical BitMap Indexing or
/// other kinds of bit-efficient indexing.
///
/// You should use the `get_mut` method instead most of the time.
pub fn get_unknown_gen_mut(&mut self, i: usize) -> Option<(&mut T, Index)> {
match self.items.get_mut(i) {
Some(Entry::Occupied {
generation,
value,
}) => Some((value, Index { generation: *generation, index: i})),
_ => None,
}
}
}
impl<T> IntoIterator for Arena<T> {
type Item = T;
type IntoIter = IntoIter<T>;
fn into_iter(self) -> Self::IntoIter {
IntoIter {
len: self.len,
inner: self.items.into_iter(),
}
}
}
/// An iterator over the elements in an arena.
///
/// Yields `T` items.
///
/// Order of iteration is not defined.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// for i in 0..10 {
/// arena.insert(i * i);
/// }
///
/// for value in arena {
/// assert!(value < 100);
/// }
/// ```
#[derive(Clone, Debug)]
pub struct IntoIter<T> {
len: usize,
inner: vec::IntoIter<Entry<T>>,
}
impl<T> Iterator for IntoIter<T> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next() {
Some(Entry::Free { .. }) => continue,
Some(Entry::Occupied { value, .. }) => {
self.len -= 1;
return Some(value);
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len, Some(self.len))
}
}
impl<T> DoubleEndedIterator for IntoIter<T> {
fn next_back(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next_back() {
Some(Entry::Free { .. }) => continue,
Some(Entry::Occupied { value, .. }) => {
self.len -= 1;
return Some(value);
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
}
impl<T> ExactSizeIterator for IntoIter<T> {
fn len(&self) -> usize {
self.len
}
}
impl<T> FusedIterator for IntoIter<T> {}
impl<'a, T> IntoIterator for &'a Arena<T> {
type Item = (Index, &'a T);
type IntoIter = Iter<'a, T>;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
/// An iterator over shared references to the elements in an arena.
///
/// Yields pairs of `(Index, &T)` items.
///
/// Order of iteration is not defined.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// for i in 0..10 {
/// arena.insert(i * i);
/// }
///
/// for (idx, value) in &arena {
/// println!("{} is at index {:?}", value, idx);
/// }
/// ```
#[derive(Clone, Debug)]
pub struct Iter<'a, T: 'a> {
len: usize,
inner: iter::Enumerate<slice::Iter<'a, Entry<T>>>,
}
impl<'a, T> Iterator for Iter<'a, T> {
type Item = (Index, &'a T);
fn next(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next() {
Some((_, &Entry::Free { .. })) => continue,
Some((
index,
&Entry::Occupied {
generation,
ref value,
},
)) => {
self.len -= 1;
let idx = Index { index, generation };
return Some((idx, value));
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len, Some(self.len))
}
}
impl<'a, T> DoubleEndedIterator for Iter<'a, T> {
fn next_back(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next_back() {
Some((_, &Entry::Free { .. })) => continue,
Some((
index,
&Entry::Occupied {
generation,
ref value,
},
)) => {
self.len -= 1;
let idx = Index { index, generation };
return Some((idx, value));
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
}
impl<'a, T> ExactSizeIterator for Iter<'a, T> {
fn len(&self) -> usize {
self.len
}
}
impl<'a, T> FusedIterator for Iter<'a, T> {}
impl<'a, T> IntoIterator for &'a mut Arena<T> {
type Item = (Index, &'a mut T);
type IntoIter = IterMut<'a, T>;
fn into_iter(self) -> Self::IntoIter {
self.iter_mut()
}
}
/// An iterator over exclusive references to elements in this arena.
///
/// Yields pairs of `(Index, &mut T)` items.
///
/// Order of iteration is not defined.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// for i in 0..10 {
/// arena.insert(i * i);
/// }
///
/// for (_idx, value) in &mut arena {
/// *value += 5;
/// }
/// ```
#[derive(Debug)]
pub struct IterMut<'a, T: 'a> {
len: usize,
inner: iter::Enumerate<slice::IterMut<'a, Entry<T>>>,
}
impl<'a, T> Iterator for IterMut<'a, T> {
type Item = (Index, &'a mut T);
fn next(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next() {
Some((_, &mut Entry::Free { .. })) => continue,
Some((
index,
&mut Entry::Occupied {
generation,
ref mut value,
},
)) => {
self.len -= 1;
let idx = Index { index, generation };
return Some((idx, value));
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len, Some(self.len))
}
}
impl<'a, T> DoubleEndedIterator for IterMut<'a, T> {
fn next_back(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next_back() {
Some((_, &mut Entry::Free { .. })) => continue,
Some((
index,
&mut Entry::Occupied {
generation,
ref mut value,
},
)) => {
self.len -= 1;
let idx = Index { index, generation };
return Some((idx, value));
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
}
impl<'a, T> ExactSizeIterator for IterMut<'a, T> {
fn len(&self) -> usize {
self.len
}
}
impl<'a, T> FusedIterator for IterMut<'a, T> {}
/// An iterator that removes elements from the arena.
///
/// Yields pairs of `(Index, T)` items.
///
/// Order of iteration is not defined.
///
/// Note: All elements are removed even if the iterator is only partially consumed or not consumed at all.
///
/// # Examples
///
/// ```
/// use generational_arena::Arena;
///
/// let mut arena = Arena::new();
/// let idx_1 = arena.insert("hello");
/// let idx_2 = arena.insert("world");
///
/// assert!(arena.get(idx_1).is_some());
/// assert!(arena.get(idx_2).is_some());
/// for (idx, value) in arena.drain() {
/// assert!((idx == idx_1 && value == "hello") || (idx == idx_2 && value == "world"));
/// }
/// assert!(arena.get(idx_1).is_none());
/// assert!(arena.get(idx_2).is_none());
/// ```
#[derive(Debug)]
pub struct Drain<'a, T: 'a> {
len: usize,
inner: iter::Enumerate<vec::Drain<'a, Entry<T>>>,
}
impl<'a, T> Iterator for Drain<'a, T> {
type Item = (Index, T);
fn next(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next() {
Some((_, Entry::Free { .. })) => continue,
Some((index, Entry::Occupied { generation, value })) => {
let idx = Index { index, generation };
self.len -= 1;
return Some((idx, value));
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len, Some(self.len))
}
}
impl<'a, T> DoubleEndedIterator for Drain<'a, T> {
fn next_back(&mut self) -> Option<Self::Item> {
loop {
match self.inner.next_back() {
Some((_, Entry::Free { .. })) => continue,
Some((index, Entry::Occupied { generation, value })) => {
let idx = Index { index, generation };
self.len -= 1;
return Some((idx, value));
}
None => {
debug_assert_eq!(self.len, 0);
return None;
}
}
}
}
}
impl<'a, T> ExactSizeIterator for Drain<'a, T> {
fn len(&self) -> usize {
self.len
}
}
impl<'a, T> FusedIterator for Drain<'a, T> {}
impl<T> Extend<T> for Arena<T> {
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
for t in iter {
self.insert(t);
}
}
}
impl<T> FromIterator<T> for Arena<T> {
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
let iter = iter.into_iter();
let (lower, upper) = iter.size_hint();
let cap = upper.unwrap_or(lower);
let cap = cmp::max(cap, 1);
let mut arena = Arena::with_capacity(cap);
arena.extend(iter);
arena
}
}
impl<T> ops::Index<Index> for Arena<T> {
type Output = T;
fn index(&self, index: Index) -> &Self::Output {
self.get(index).expect("No element at index")
}
}
impl<T> ops::IndexMut<Index> for Arena<T> {
fn index_mut(&mut self, index: Index) -> &mut Self::Output {
self.get_mut(index).expect("No element at index")
}
}