thunderdome 0.6.1

Fast arena allocator with compact generational indices
Documentation 
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

# Thunderdome Changelog

## Unreleased Changes

## [0.6.1] - 2023-06-24
* Added `Index::DANGLING`.
* Replaced unsafe code in `get2_mut` with safe equivalent. ([#42])

[#42]: https://github.com/LPGhatguy/thunderdome/pull/42
[0.6.1]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.6.1

## [0.6.0] - 2022-10-18
* Raised MSRV to 1.47.0.
* Many functions are now `const` ([#38])

[#38]: https://github.com/LPGhatguy/thunderdome/pull/38
[0.6.0]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.6.0

## [0.5.1] - 2022-07-04
* Fixed bug when calling `Arena::insert_at` on a slot in the middle of the free list. ([#36])
* Added `Index::generation` for extracting the generation portion of an index. ([#34])

[#34]: https://github.com/LPGhatguy/thunderdome/issues/34
[#36]: https://github.com/LPGhatguy/thunderdome/issues/36
[0.5.1]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.5.1

## [0.5.0] - 2021-10-07
* Moved iterator types into `thunderdome::iter`. ([#24])
* Changed `Index::from_bits` to return `Option<Index>` instead of `Index`, and no longer panic. ([#31])

[#24]: https://github.com/LPGhatguy/thunderdome/issues/24
[#31]: https://github.com/LPGhatguy/thunderdome/issues/31
[0.5.0]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.5.0

## [0.4.2] - 2021-10-07
* Fixed miri warning for `Arena::get2_mut`. ([#29])
* Added `Arena::insert_at` and `Arena::insert_at_slot` for inserting into specific indexes or slots. ([#30])

[#29]: https://github.com/LPGhatguy/thunderdome/pull/29
[#30]: https://github.com/LPGhatguy/thunderdome/pull/30 
[0.4.2]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.4.2

## [0.4.1] - 2021-02-24
* Implemented `IntoIterator` for `&Arena` and `&mut Arena`. ([#18])
* Added `Arena::get2_mut` for getting two mutable references of different slots at once. ([#22])

[#18]: https://github.com/LPGhatguy/thunderdome/pull/18
[#22]: https://github.com/LPGhatguy/thunderdome/pull/22
[0.4.1]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.4.1

## [0.4.0] - 2020-11-17
* Fixed `Arena::iter_mut` to return mutable references. ([#10])
* Added `Arena::retain` for conveniently removing entries which do not satisfy a given predicate. ([#11])
* Added `Arena::contains` for checking whether an `Index` is valid for a given `Arena`. ([#12])
* Added `Index::slot` for extracting the slot portion of an index as well as slot-related APIs. ([#13])
	* Added `Arena::contains_slot` for checking whether a slot is occupied in a given `Arena` and resolving its `Index` if so.
	* Added `Arena::get_by_slot` and `Arena::get_by_slot_mut` for retrieving an entry by its slot, ignoring generation.
	* Added `Arena::remove_by_slot` for removing an entry by its slot, ignoring generation.

[#10]: https://github.com/LPGhatguy/thunderdome/pull/10
[#11]: https://github.com/LPGhatguy/thunderdome/pull/11
[#12]: https://github.com/LPGhatguy/thunderdome/pull/12
[#13]: https://github.com/LPGhatguy/thunderdome/pull/13
[0.4.0]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.4.0

## [0.3.0] - 2020-10-16
* Added `Arena::invalidate` for invalidating indices on-demand, as a faster remove-followed-by-reinsert. ([#6])
* Added `Index::to_bits` and `Index::from_bits` for converting indices to a form convenient for passing outside of Rust. ([#6])
* Added `Arena::clear` for conveniently clearing the whole arena. ([#7])
* Change the semantics of `Arena::drain` to drop any remaining uniterated items when the `Drain` iterator is dropped, clearing the `Arena`. ([#8])

[#6]: https://github.com/LPGhatguy/thunderdome/pull/6
[#7]: https://github.com/LPGhatguy/thunderdome/pull/7
[#8]: https://github.com/LPGhatguy/thunderdome/pull/8
[0.3.0]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.3.0

## [0.2.1] - 2020-10-01
* Added `Default` implementation for `Arena`.
* Added `IntoIterator` implementation for `Arena` ([#1](https://github.com/LPGhatguy/thunderdome/issues/1))
* Added `Arena::iter` and `Arena::iter_mut` ([#2](https://github.com/LPGhatguy/thunderdome/issues/2))

[0.2.1]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.2.1

## [0.2.0] - 2020-09-03
* Bumped MSRV to 1.34.1.
* Reduced size of `Index` by limiting `Arena` to 2^32 elements and 2^32 generations per slot.
	* These limits should not be hit in practice, but will consistently trigger panics.
* Changed generation counter to wrap instead of panic on overflow.
	* Collisions where an index using the same slot and a colliding generation on [1, 2^32] should be incredibly unlikely.

[0.2.0]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.2.0

## [0.1.1] - 2020-09-02
* Added `Arena::with_capacity` for preallocating space.
* Added `Arena::len`, `Arena::capacity`, and `Arena::is_empty`.
* Improved panic-on-wrap guarantees, especially around unsafe code.
* Simplified and documented implementation.

[0.1.1]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.1.1

## [0.1.0] - 2020-09-02
* Initial release

[0.1.0]: https://github.com/LPGhatguy/thunderdome/releases/tag/v0.1.0