stable-vec 0.4.2

A Vec-like collection which guarantees stable indices and features O(1) element deletion (semantically similar to `Vec<Option<T>>`). Useful for allocations in graphs or similar data structures.
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
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

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.4.2] - 2026-03-07
- Fix lifetime warning for `values_mut` in [#49](https://github.com/LukasKalbertodt/stable-vec/pull/49), thanks @roeeshoshani
- Remove `no-std-compat` dependency in [#43](https://github.com/LukasKalbertodt/stable-vec/pull/43), thanks @Luro02
- Add `rust-version` to `Cargo.toml` (it's 1.36, unchanged from 0.4.1)
- Remove `badges` section from `Cargo.toml`

## [0.4.1] - 2024-03-17
- Fix UB in `InlineStableVec` (`OptionCore`) in [#45](https://github.com/LukasKalbertodt/stable-vec/pull/45) & [#46](https://github.com/LukasKalbertodt/stable-vec/pull/46). Thanks a lot @ratmice for detecting and fixing this.
- Fix badges in README
- Internal: switch from Travis-CI to GitHub actions

## [0.4.0] - 2019-08-26
This is a pretty large release. The whole crate was more or less completely
rewritten. So it might almost be more useful to forget everything about the
crate and learn everything anew instead of digging through this changelog.

### Added
- `Core` trait and two implementations
- Add `StableVec`, `ExternStableVec` and `InlineStableVec` type aliases for
  `StableVecFacade`
- `Iter` and `IterMut` which iterate over (index, reference) pairs
- All iterators implement `DoubleSidedIterator` and `FusedIterator`
- `StableVecFacade::{get_unchecked, get_unchecked_mut}`
- `StableVecFacade::{reserve_exact, reserve_for}`
- `StableVecFacade::{first_filled_slot_from, first_filled_slot_below}`
- `StableVecFacade::{first_empty_slot_from, first_empty_slot_below}`
- `StableVecFacade::swap`

### Changed
- Notable performance improvements crate-wide
- `StableVec` has been renamed to `StableVecFacade` and is generic over a
  "core" (parameter `C`)
- Move iterators into `iter` submodule
- The terminology in the documentation changed a bit (notably: "empty or filled
  slots" instead of "deleted or existing elements")
- `PartialEq<StableVecFacade>` not compares all observable properties
- Rename `Iter`/`IterMut` into `Values`/`ValuesMut`
- Rename `StableVecFacade::next_index` to `next_push_index`
- Rename `keys`/`Keys` to `indices`/`Indices`
- Replace `insert_into_hole` with `insert`
- The `IntoIter` now yields (index, value) pairs
- The crate `bit-vec` is no longer used and has been replaced by our own
  implementation
- The crate is now usable in `no_std` context (still requires `alloc` though)

### Removed
- `StableVecFacade::into_vec`
- `StableVecFacade::from_vec`
- `StableVecFacade::grow`
- `io::Write` impl for `StableVecFacade<u8>`


## [0.3.2] - 2019-04-09
### Added
- `remove_last`
- `remove_first`
- `find_first`
- `find_first_mut`
- `find_first_index`
- `find_last`
- `find_last_mut`
- `find_last_index`
- `retain_indices`

### Fixed
- Suboptimal use of `bit-vec` which lead to suboptimal generated assembly.
  Now the most important occurences of this are fixed.


## [0.3.1] - 2019-01-24
### Fixed
- Fix memory safety bug in `clone()`: cloning a non-compact stable vec before
  this change accessed already dropped values and attempted to clone them.
- Fix memory safety bug in `clear()`: calling `clear()` on a non-compact
  stable vec before would access already dropped values and drop them a second
  time.

## [0.3.0] - 2019-01-07
### Removed
- Remove `IterMut::remove_current`. The method was broken because it did not
  drop the removed value properly. On closer inspection, the method was a bit
  broken in some other minor other ways because it was badly designed. For now
  it is just removed and may reappear with good design in the future.

## [0.2.2] - 2019-01-07
### Added
- All three iterators implement `Iterator::size_hint` and `ExactSizeIterator`
  now and report the correct length.

## [0.2.1] - 2018-09-26
### Added
- `StableVec::insert_into_hole()`
- `StableVec::grow()`
- `StableVec::clear()`
- `StableVec::from_vec()`
- `StableVec::extend_from_slice()`
- `Debug` implementations for `Iter`, `IterMut` and `Keys`
- `Write` implementation for `StableVec<u8>`

### Changed
- The `Drop` impl now uses the `mem::needs_drop()` optimization hint to avoid
  unnecessary overhead.
- Updated `bit-vec` from `0.4` to `0.5`

## [0.2.0] - 2017-09-17
### Added
- Added method overview in documentation
- `StableVec::contains()`
- `StableVec::into_vec()`
- `StableVec::retain()`
- `StableVec::make_compact()`
- `StableVec::keys()` with `Keys` iterator
- `IterMut::remove_current()`
- `impl<T> Default for StableVec<T>`
- Added `FromIterator` impl for `StableVec`
- Added `Extend` impl for `StableVec`
- Added `Debug` impl for `StableVec` with a fitting example
- Added `PartialEq` impls to compare a `StableVec` with slices and `Vec`s

### Changed
- Renamed `compact()` to `reordering_make_compact()`: changing element order by
  default is a bad idea. Instead `make_compact()` should be used to preserve
  order.
- Renamed `exists()` to `has_element_at()`

## [0.1.2] - 2017-09-15
### Fixed
- Travis-CI badge entry in `Cargo.toml`
- Warning in example

## [0.1.1] - 2017-09-15
### Added
- Added this `CHANGELOG.md`
- Metadata to `Cargo.toml`

### Changed
- Documentation examples are now clearer by calling variables storing indices
  `_idx` at the end

### Fixed
- Fixed panic in the `Iter` iterator impl which occured when the last element
  was removed from the vector before

## 0.1.0 - 2017-06-21
### Added
- Everything.


[Unreleased]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.4.2...HEAD
[0.4.2]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.4.1...v0.4.2
[0.4.1]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.4.0...v0.4.1
[0.4.0]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.3.2...v0.4.0
[0.3.2]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.2.2...v0.3.0
[0.2.2]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.2.1...v0.2.2
[0.2.1]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.1.2...v0.2.0
[0.1.2]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/LukasKalbertodt/stable-vec/compare/v0.1.0...v0.1.1