fast_collections 0.30.0

noheap zero copy collections
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

use generic_array::ArrayLength;
use mutification::ToMut;

use crate::{Clear, GetUnchecked, Index, Pop, Push, RemoveUnchecked, Vec};

///Simply store element fast without any other features like get length, and iteration.
#[derive(ToMut)]
pub struct Slab<T, N: ArrayLength> {
    chunk: Vec<T, N>,
    spares: Vec<usize, N>,
}

impl<T, N> Default for Slab<T, N>
where
    N: ArrayLength,
{
    fn default() -> Self {
        Self {
            chunk: Default::default(),
            spares: Default::default(),
        }
    }
}

impl<T, N: ArrayLength> Index for Slab<T, N> {
    type Index = usize;
}

impl<T, N> GetUnchecked<T> for Slab<T, N>
where
    N: ArrayLength,
{
    ///After removing an element, be cautious as you might still unintentionally access it using [Self::get_unchecked_mut].
    unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
        self.chunk.get_unchecked_mut(index)
    }

    unsafe fn get_unchecked_ref(&self, index: Self::Index) -> &T {
        self.chunk.get_unchecked_ref(index)
    }
}

impl<T, N> Clear for Slab<T, N>
where
    N: ArrayLength,
{
    fn clear(&mut self) {
        self.chunk.clear();
        self.spares.clear();
    }
}

impl<T, N> RemoveUnchecked for Slab<T, N>
where
    N: ArrayLength,
{
    unsafe fn remove_unchecked(&mut self, index: usize) {
        self.spares.push_unchecked(index);
    }
}

impl<T, N> Slab<T, N>
where
    N: ArrayLength,
{
    pub fn new() -> Slab<T, N> {
        Slab {
            chunk: Vec::uninit(),
            spares: Vec::uninit(),
        }
    }

    #[inline(always)]
    pub fn add_with_index<F>(&mut self, f: F) -> Result<<Self as Index>::Index, ()>
    where
        F: FnOnce(<Self as Index>::Index) -> T,
    {
        if self.spares.len() == 0 {
            let index = self.chunk.len();
            if index == N::USIZE {
                return Err(());
            }
            let elem = f(index);
            unsafe { self.chunk.push_unchecked(elem) };
            Ok(index)
        } else {
            let index = *unsafe { self.spares.pop_unchecked() };
            let elem = f(index);
            *unsafe { self.chunk.get_unchecked_mut(index) } = elem;
            Ok(index)
        }
    }
}

#[cfg(test)]
mod test {
    use crate::GetUnchecked;

    use super::Slab;
    use generic_array::typenum::U100;

    #[test]
    fn test() {
        #[derive(Debug, PartialEq, Eq)]
        struct A {
            inner: usize,
            index: usize,
        }
        let mut value = Slab::<A, U100>::new();
        value
            .add_with_index(|index| A { inner: 123, index })
            .unwrap();
        value
            .add_with_index(|index| A { inner: 456, index })
            .unwrap();
        assert_eq!(
            unsafe { value.get_unchecked_ref(0) },
            &A {
                inner: 123,
                index: 0
            }
        );
        assert_eq!(
            unsafe { value.get_unchecked_ref(1) },
            &A {
                inner: 456,
                index: 1
            }
        );
    }
}