Crate slotmap_careful

Source
Expand description

§slotmap-careful: Wrapper for slotmap generational arena to prevent key reuse.

The slotmap generational arena implementation is efficient and easy to use. Unfortunately, it has a behavior where if a single index slot is reused about 2^31 times, its version field will wrap around, and the same key will be returned twice. This can lead to security problems in programs that rely on each for a slotmap being permanently unique.

This crate implement a wrapper around slotmap::SlotMap to prevent key reuse. It works by noticing when any slot with a very high version counter is about to become empty, and instead marking such slots as permanently unusable.

Note that this new behavior can result in memory usage that grows slowly over time, even if the actual capacity of the slotmap remains low.

Modules§

secondary
Contains the secondary map implementation.

Macros§

new_key_type
A helper macro to create new key types. If you use a new key type for each slot map you create you can entirely prevent using the wrong key on the wrong slot map.

Structs§

DefaultKey
The default slot map key type.
DenseSlotMap
A variation of slotmap::DenseSlotMap that can never give the same key for multiple objects.
HopSlotMap
A variation of slotmap::HopSlotMap that can never give the same key for multiple objects.
KeyData
The actual data stored in a Key.
SecondaryMap
Secondary map, associate data with previously stored elements in a slot map.
SlotMap
A variation of slotmap::SlotMap that can never give the same key for multiple objects.
SparseSecondaryMap
Sparse secondary map, associate data with previously stored elements in a slot map.

Traits§

Key
Key used to access stored values in a slot map.