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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/// A dynamic vector that can store elements on both the stack and the heap.
///
/// The `DynamicVec` struct provides a flexible vector implementation that can store elements
/// on the stack using the `heapless::Vec` type and on the heap using the `Vec` type.
/// It allows for efficient storage of small vectors on the stack while automatically
/// falling back to the heap for larger vectors.
///
/// # Examples
///
/// Creating a new `DynamicVec`:
///
/// ```
/// use sans_io_runtime::collections::DynamicVec;
///
/// let mut vec: DynamicVec<u32, 10> = DynamicVec::default();
/// ```
///
/// Pushing elements into the `DynamicVec`:
///
/// ```
/// use sans_io_runtime::collections::DynamicVec;
///
/// let mut vec: DynamicVec<u32, 10> = DynamicVec::default();
/// vec.push(1);
/// vec.push(2);
/// vec.push_stack(3).unwrap();
/// ```
///
/// Accessing elements in the `DynamicVec`:
///
/// ```
/// use sans_io_runtime::collections::DynamicVec;
///
/// let mut vec: DynamicVec<u32, 10> = DynamicVec::default();
/// vec.push(1);
/// vec.push(2);
/// vec.push_stack(3).unwrap();
///
/// assert_eq!(vec.get(0), Some(&1));
/// assert_eq!(vec.get(1), Some(&2));
/// assert_eq!(vec.get(2), Some(&3));
/// ```
pub struct DynamicVec<T, const STACK_SIZE: usize> {
    stack: heapless::Vec<T, STACK_SIZE>,
    heap: Vec<T>,
}

impl<T, const STACK_SIZE: usize> Default for DynamicVec<T, STACK_SIZE> {
    fn default() -> Self {
        Self {
            stack: heapless::Vec::new(),
            heap: Vec::new(),
        }
    }
}

#[allow(unused)]
impl<T, const STACK_SIZE: usize> DynamicVec<T, STACK_SIZE> {
    /// Creates a new instance of `DynamicVec` from an array of elements.
    pub fn from<const SIZE: usize>(prepare: [T; SIZE]) -> Self {
        let mut instance = DynamicVec::<T, STACK_SIZE>::default();
        for item in prepare {
            instance.push(item);
        }
        instance
    }

    pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T> {
        self.stack.iter_mut().chain(self.heap.iter_mut())
    }

    pub fn iter(&self) -> impl Iterator<Item = &T> {
        self.stack.iter().chain(self.heap.iter())
    }

    /// Get the element at the given index.
    pub fn get(&self, index: usize) -> Option<&T> {
        if index < self.stack.len() {
            Some(&self.stack[index])
        } else {
            self.heap.get(index - self.stack.len())
        }
    }

    /// Get the mutable element at the given index.
    pub fn get_mut(&mut self, index: usize) -> Option<&mut T> {
        if index < self.stack.len() {
            Some(&mut self.stack[index])
        } else {
            self.heap.get_mut(index - self.stack.len())
        }
    }

    /// Get the mutable element at the given index or panic if not exists.
    pub fn get_mut_or_panic(&mut self, index: usize) -> &mut T {
        if index < self.stack.len() {
            &mut self.stack[index]
        } else {
            &mut self.heap[index - self.stack.len()]
        }
    }

    /// Push an element to the stack of the vector.
    pub fn push_stack(&mut self, value: T) -> Result<(), T> {
        self.stack.push(value)
    }

    /// Push an element to the stack or the heap of the vector.
    pub fn push(&mut self, value: T) {
        if let Err(value) = self.stack.push(value) {
            self.heap.push(value);
        }
    }

    /// Pops the element from the end of the vector.
    pub fn pop(&mut self) -> Option<T> {
        if let Some(t) = self.heap.pop() {
            Some(t)
        } else {
            self.stack.pop()
        }
    }

    pub fn last(&self) -> Option<&T> {
        if let Some(t) = self.heap.last() {
            Some(t)
        } else {
            self.stack.last()
        }
    }

    /// Check if the vector is empty.
    pub fn is_empty(&self) -> bool {
        self.stack.is_empty()
    }

    /// Returns the number of elements in the vector.
    pub fn len(&self) -> usize {
        self.stack.len() + self.heap.len()
    }
}

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

    #[test]
    fn test_new() {
        let vec: DynamicVec<u32, 10> = DynamicVec::default();
        assert!(vec.is_empty());
        assert_eq!(vec.len(), 0);
    }

    #[test]
    fn test_from() {
        let arr = [1, 2, 3, 4, 5];
        let vec: DynamicVec<u32, 10> = DynamicVec::from(arr);
        assert_eq!(vec.len(), arr.len());
        for (i, item) in arr.iter().enumerate() {
            assert_eq!(vec.get(i), Some(item));
        }
    }

    #[test]
    fn test_push() {
        let mut vec: DynamicVec<u32, 2> = DynamicVec::default();
        vec.push(1);
        vec.push(2);
        vec.push(3);
        assert_eq!(vec.push_stack(4), Err(4));
        assert_eq!(vec.len(), 3);
        assert_eq!(vec.get(0), Some(&1));
        assert_eq!(vec.get(1), Some(&2));
        assert_eq!(vec.get(2), Some(&3));
    }

    #[test]
    fn test_push_stack() {
        let mut vec: DynamicVec<u32, 2> = DynamicVec::default();
        assert_eq!(vec.push_stack(1), Ok(()));
        assert_eq!(vec.push_stack(2), Ok(()));
        assert_eq!(vec.push_stack(3), Err(3));
        assert_eq!(vec.len(), 2);
        assert_eq!(vec.get(0), Some(&1));
        assert_eq!(vec.get(1), Some(&2));
    }

    #[test]
    fn test_push_safe() {
        let mut vec: DynamicVec<u32, 2> = DynamicVec::default();
        vec.push(1);
        vec.push(2);
        vec.push(3);
        assert_eq!(vec.len(), 3);
        assert_eq!(vec.get(0), Some(&1));
        assert_eq!(vec.get_mut_or_panic(0), &1);
        assert_eq!(vec.get(1), Some(&2));
        assert_eq!(vec.get_mut_or_panic(1), &2);
        assert_eq!(vec.get(2), Some(&3));
        assert_eq!(vec.get_mut_or_panic(2), &3);
    }

    #[test]
    fn test_pop() {
        let mut vec: DynamicVec<u32, 2> = DynamicVec::default();
        vec.push(1);
        vec.push(2);
        assert_eq!(vec.pop(), Some(2));
        assert_eq!(vec.pop(), Some(1));
        assert_eq!(vec.pop(), None);
        assert_eq!(vec.len(), 0);
        assert!(vec.is_empty());
    }
}