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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
#![warn(clippy::all)]
use crate::error::ArrTooSmall;
use std::fmt::{Debug, Formatter};
use std::ops::Index;
use std::vec::IntoIter;
#[cfg(test)]
mod test;
/// A Vec but entirely on the stack.
///
/// # Example:
/// ```
/// use vec_array::vec::VecArray;
///
/// let mut vec: VecArray<_, 10> = VecArray::new();
/// vec.push(9).unwrap();
/// assert_eq!(vec[0], 9);
/// ```
#[derive(Clone)]
pub struct VecArray<T, const CAP: usize> {
arr: [T; CAP],
len: usize,
}
/// Does the same as ::new
impl<T, const CAP: usize> Default for VecArray<T, CAP> {
fn default() -> Self {
Self::new()
}
}
impl<T, const CAP: usize> VecArray<T, CAP> {
/// Creates a new VecArray.
///
/// # Example:
/// ```
/// use vec_array::vec::VecArray;
///
/// let mut vec: VecArray<_, 10> = VecArray::new();
/// vec.push(9).unwrap();
/// assert_eq!(vec[0], 9);
/// ```
///
/// # Safety:
/// There may be problems if you try to index in to parts of the array which are no yet initialized but this is nearly impossible.
///
#[allow(clippy::uninit_assumed_init)]
pub fn new() -> Self {
Self {
arr: unsafe { std::mem::MaybeUninit::uninit().assume_init() },
len: 0,
}
}
/// Pushes an element.
///
/// # Example:
/// ```
/// use vec_array::vec::VecArray;
///
/// let mut vec: VecArray<_, 10> = VecArray::new();
/// vec.push(9).unwrap();
/// assert_eq!(vec[0], 9);
/// ```
pub fn push(&mut self, value: T) -> Result<(), ArrTooSmall> {
if self.len < CAP {
self.arr[self.len] = value;
self.len += 1;
Ok(())
} else {
Err(ArrTooSmall)
}
}
/// Removes the last element
///
/// # Example:
/// ```
/// use vec_array::vec::VecArray;
///
/// let mut vec: VecArray<_, 10> = VecArray::new();
/// vec.push(9).unwrap();
/// assert_eq!(vec.pop(), Some(9));
/// ```
///
/// # Safety:
/// Returns memory which will realistically wont be used anymore
///
pub fn pop(&mut self) -> Option<T> {
if self.len == 0 {
None
} else {
self.len -= 1;
Some(unsafe { std::ptr::read(&self.arr[self.len] as *const T) })
}
}
/// Removes an element.
///
/// # Panics:
/// If index is greater than or equal to length
///
/// # Example:
/// ```
/// use vec_array::vec::VecArray;
/// let mut vec: VecArray<_, 10> = VecArray::new();
/// vec.push(9).unwrap();
/// vec.remove(0);
/// assert!(vec.is_empty());
/// ```
///
/// # Safety:
/// Copied from Vec source code
///
pub fn remove(&mut self, index: usize) -> T {
let len = self.len;
if index >= len {
panic!("Removal index (is {index}) should be < len (is {len})");
}
unsafe {
// infallible
let ret;
{
// the place we are taking from.
let ptr = self.arr.as_mut_ptr().add(index);
// copy it out, unsafely having a copy of the value on
// the stack and in the vector at the same time.
ret = std::ptr::read(ptr);
// Shift everything down to fill in that spot.
std::ptr::copy(ptr.add(1), ptr, len - index - 1);
}
self.len -= 1;
ret
}
}
pub fn get(&self, index: usize) -> Option<&T> {
if index >= self.len {
None
} else {
Some(&self.arr[index])
}
}
pub fn truncate(&mut self, len: usize) {
if len > self.len {
return;
}
self.len = len;
}
#[inline]
pub fn as_mut_ptr(&mut self) -> *mut T {
self.arr.as_mut_ptr()
}
#[inline]
pub fn as_ptr(&self) -> *const T {
self.arr.as_ptr()
}
#[inline]
pub fn get_arr(self) -> [T; CAP] {
self.arr
}
#[inline]
pub fn len(&self) -> usize {
self.len
}
#[inline]
pub fn is_empty(&self) -> bool {
self.len == 0
}
#[inline]
pub fn as_slice(&self) -> &[T] {
&self.arr[..self.len]
}
#[inline]
pub fn as_mut_slice(&mut self) -> &mut [T] {
&mut self.arr[..self.len]
}
#[inline]
pub fn clear(&mut self) {
self.len = 0;
}
#[inline]
pub fn capacity(&self) -> usize {
CAP
}
}
impl<T, const CAP: usize> From<VecArray<T, CAP>> for Vec<T> {
fn from(val: VecArray<T, CAP>) -> Self {
let mut vec = Vec::from(val.arr);
vec.truncate(val.len);
vec
}
}
impl<T, const CAP: usize> Index<usize> for VecArray<T, CAP> {
type Output = T;
/// # Panics:
/// If index is greater than or equal to length
///
/// Use .get instead
fn index(&self, index: usize) -> &Self::Output {
if index >= self.len {
panic!("Index too big");
} else {
&self.arr[index]
}
}
}
impl<T, const CAP: usize> From<Vec<T>> for VecArray<T, CAP> {
/// # Panics:
/// If inputs length is greater than CAP
///
fn from(value: Vec<T>) -> Self {
if value.len() > CAP {
panic!("Vector too long");
} else {
let mut slf = Self::new();
for x in value {
slf.push(x).unwrap();
}
slf
}
}
}
impl<T, const CAP: usize> IntoIterator for VecArray<T, CAP> {
type Item = T;
type IntoIter = IntoIter<Self::Item>;
fn into_iter(self) -> Self::IntoIter {
Vec::from(self).into_iter()
}
}
impl<T, const CAP: usize> Debug for VecArray<T, CAP>
where
T: Debug,
{
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let vec = (0..self.len).map(|i| &self.arr[i]).collect::<Vec<_>>();
if f.alternate() {
write!(f, "{vec:#?}")
} else {
write!(f, "{vec:?}")
}
}
}
impl<T, const CAP: usize> PartialEq for VecArray<T, CAP>
where
T: PartialEq,
{
fn eq(&self, other: &Self) -> bool {
if self.len != other.len {
false
} else {
for i in 0..self.len {
if self.arr[i] != other.arr[i] {
return false;
}
}
true
}
}
}
/// Creates a VecArray just like the vec! macro
#[macro_export()]
macro_rules! vec_arr {
() => { VecArray::new() };
($($x:expr),+ $(,)?) => {
{
let mut temp_vec = VecArray::new();
$(
temp_vec.push($x).expect(&format!("VecArray to small, (used in macro vec_arr! at line {})", line!()));
)*
temp_vec
}
};
($x:expr; $n:literal) => {
{
let mut temp_vec = VecArray::new();
for i in 0..$n => {
temp_vec.push($x.clone()).expect(&format!("VecArray to small, (used in macro vec_arr! at line {})", line!()));
}
temp_vec
}
}
}