fast_collections 0.58.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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use std::ptr::drop_in_place;

use crate::Vec;

///Fast and simple storage without any other features like get length, and iteration.
pub struct Slab<T, const N: usize> {
    chunk: Vec<Option<T>, N>,
    spares: Vec<usize, N>,
}

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

    pub fn get(&self, index: usize) -> Option<&T> {
        unsafe { self.chunk.get_unchecked(index).as_ref() }
    }

    pub fn get_mut(&mut self, index: usize) -> Option<&mut T> {
        unsafe { self.chunk.get_unchecked_mut(index).as_mut() }
    }

    ///After removing an element, be cautious as you might still unintentionally access it using [Self::get_unchecked_mut].
    pub unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
        self.chunk
            .get_unchecked_mut(index.into())
            .as_mut()
            .unwrap_unchecked()
    }

    pub unsafe fn get_unchecked(&self, index: usize) -> &T {
        self.chunk
            .get_unchecked(index.into())
            .as_ref()
            .unwrap_unchecked()
    }

    pub fn clear(&mut self) {
        for ele in self.chunk.iter_mut() {
            if let Some(ele) = ele {
                unsafe { drop_in_place(ele as *mut T) }
            }
        }
        self.chunk.clear();
        self.spares.clear();
    }

    pub unsafe fn remove_unchecked(&mut self, index: usize) {
        *self.chunk.get_unchecked_mut(index.into()) = None;
        self.spares.push_unchecked(index.into());
    }

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

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

#[cfg(test)]
mod test {
    use super::Slab;

    #[test]
    fn test() {
        #[derive(Debug, PartialEq, Eq)]
        struct A {
            inner: usize,
            index: usize,
        }
        struct Id(usize);
        impl Into<usize> for &Id {
            fn into(self) -> usize {
                self.0
            }
        }
        let mut value = Slab::<A, 100>::new();
        value
            .add_with_index(|index| A {
                inner: 123,
                index: *index,
            })
            .unwrap();
        value
            .add_with_index(|index| A {
                inner: 456,
                index: *index,
            })
            .unwrap();
        assert_eq!(
            unsafe { value.get_unchecked(0) },
            &A {
                inner: 123,
                index: 0
            }
        );
        assert_eq!(
            unsafe { value.get_unchecked(1) },
            &A {
                inner: 456,
                index: 1
            }
        );
    }

    #[test]
    fn drop_test() {
        struct Token(usize);
        let mut slab: Slab<Token, 10> = Slab::new();
        static mut value: bool = false;
        impl Drop for Token {
            fn drop(&mut self) {
                self.0 = 123;
                unsafe { value = true };
                println!("HI");
            }
        }
        slab.add_with_index(|i| Token(1)).unwrap();
        unsafe { slab.remove_unchecked(0) };
        assert_eq!(unsafe { value }, true)
    }
}