typed_generational_arena/
presets.rs

1use super::{Arena, Index, NonzeroGeneration, NonzeroWrapGeneration, NonZeroIndex, DisableRemoval};
2
3/// An arena of `T` indexed by `usize`, with `2^{64}` generations
4pub type U64Arena<T> = Arena<T, usize, u64>;
5/// An index into a `U64Arena`
6pub type U64Index<T> = Index<T, usize, u64>;
7/// A standard arena of `T` indexed by `usize`, with `2^{64} - 1` generations
8pub type StandardArena<T> =  Arena<T, usize, NonzeroGeneration<usize>>;
9/// A typed index into a `StandardArena`
10pub type StandardIndex<T> = Index<T, usize, NonzeroGeneration<usize>>;
11/// An arena which can only hold up to \(2^{32} - 1\) elements and generations
12pub type SmallArena<T> = Arena<T, u32, NonzeroGeneration<u32>>;
13/// A typed index into a `StandardArena`
14pub type SmallIndex<T> = Index<T, u32, NonzeroGeneration<u32>>;
15/// An arena which can only hold up to \(2^{16}\) elements and \(2^{16} - 1\) generations
16pub type TinyArena<T> = Arena<T, u16, NonzeroGeneration<u16>>;
17/// A typed index into a `StandardArena`
18pub type TinyIndex<T> = Index<T, u16, NonzeroGeneration<u16>>;
19/// An arena which can only hold up to \(2^{16}\) elements, but unlimited
20/// generations, with the caveat that generations after \(2^{16} - 1\) wrap and hence
21/// may, with low probability,  collide,  leading, for example, to reading a new value
22///  when the old one was deleted.
23pub type TinyWrapArena<T> = Arena<T, u16, NonzeroWrapGeneration<u16>>;
24/// A typed index into a `TinyWrapArena`
25pub type TinyWrapIndex<T> = Index<T, u16, NonzeroWrapGeneration<u16>>;
26/// An arena which can only hold up to \(2^{8}\) elements, but unlimited
27/// generations, with the caveat that generations after \(2^{8}\) wrap
28/// and hence may  collide, leading, for example, to reading a new value when
29/// the old one was deleted.
30pub type NanoArena<T> = Arena<T, u8, core::num::Wrapping<u8>>;
31/// A typed index into a `NanoArena`
32pub type NanoIndex<T> = Index<T, u8, core::num::Wrapping<u8>>;
33/// An arena which can only hold up to \(2^{8} - 1\) elements, but unlimited
34/// generations, with the caveat that generations after \(2^{8} - 1\) wrap
35/// and hence may  collide, leading, for example, to reading a new value when
36/// the old one was deleted.
37pub type PicoArena<T> = Arena<T, u8, NonzeroWrapGeneration<u8>>;
38/// A typed index into a `NanoArena`
39pub type PicoIndex<T> = Index<T, u8, NonzeroWrapGeneration<u8>>;
40/// A slab arena with a given index, which does *not* support efficient removal
41pub type Slab<T, I> = Arena<T, I, DisableRemoval>;
42/// An index into a slab of type `T` by a certain type
43pub type SlabIndex<T, I> = Index<T, I, DisableRemoval>;
44/// A standard slab arena which can hold up to `std::usize::MAX` elements but does
45/// *not* support element removal
46pub type StandardSlab<T> = Slab<T, usize>;
47/// An index into a `Slab<T>`
48pub type StandardSlabIndex<T> = SlabIndex<T, usize>;
49/// A slab arena which can hold up to `2^{32}` elements but does *not* support
50/// element removal
51pub type SmallSlab<T> = Slab<T, u32>;
52/// An index into a `SmallSlab<T>`
53pub type SmallSlabIndex<T> = SlabIndex<T, u32>;
54/// A slab arena which can hold up to `std::usize::MAX - 1` elements but does
55/// *not* support element removal, and has size optimized optional indices
56pub type PtrSlab<T> = Slab<T, NonZeroIndex<usize>>;
57/// An index into a `PtrSlab<T>`
58pub type PtrSlabIndex<T> = SlabIndex<T, NonZeroIndex<usize>>;
59/// A slab arena which can hold up to `2^{32} - 1` elements but does *not* support
60/// element removal, and has size optimized optional indices
61pub type SmallPtrSlab<T> = Slab<T, NonZeroIndex<u32>>;
62/// An index into a `SmallPtrSlab<T>`
63pub type SmallPtrSlabIndex<T> = SlabIndex<T, NonZeroIndex<u32>>;
typed_generational_arena/presets.rs

typed_generational_arena/
presets.rs
