generic-vec 0.1.0-alpha

a vector implementation that can be used in `no_std` envioronments
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

use crate::raw::{AllocError, Init, Storage, StorageWithCapacity, Uninit};
use core::mem::{size_of, MaybeUninit};

/// An uninitialized array storage
pub type UninitArray<T, const N: usize> = Uninit<MaybeUninit<[T; N]>>;
/// An initialized array storage
pub type Array<T, const N: usize> = Init<[T; N]>;

unsafe impl<T, const N: usize> Send for UninitArray<T, N> {}
unsafe impl<T, const N: usize> Sync for UninitArray<T, N> {}

impl<T, const N: usize> UninitArray<T, N> {
    /// Create a new uninitialized array storage
    pub const fn uninit() -> Self { Self(MaybeUninit::uninit()) }

    /// Create a new uninitialized array storage, with the given array
    pub const fn with_array(array: [T; N]) -> Self { Self(MaybeUninit::new(array)) }
}

impl<T, const N: usize> Array<T, N> {
    /// Create a new initialized array storage, with the given array
    pub const fn new(array: [T; N]) -> Self { Self(array) }
}

impl<T, const N: usize> Default for UninitArray<T, N> {
    fn default() -> Self { Self::uninit() }
}

impl<T: Default + Copy, const N: usize> Default for Array<T, N> {
    fn default() -> Self { Self([T::default(); N]) }
}

impl<T, const N: usize> Clone for UninitArray<T, N> {
    fn clone(&self) -> Self { Self::default() }
}

impl<T: Copy, const N: usize> Copy for Array<T, N> {}
impl<T: Copy, const N: usize> Clone for Array<T, N> {
    fn clone(&self) -> Self { *self }
}

impl<U, T, const N: usize> StorageWithCapacity<U> for UninitArray<T, N> {
    fn with_capacity(capacity: usize) -> Self {
        if capacity > N {
            crate::raw::fixed_capacity_reserve_error(N, capacity)
        }

        Self::default()
    }

    #[inline]
    #[doc(hidden)]
    #[allow(non_snake_case)]
    fn __with_capacity__const_capacity_checked(capacity: usize, old_capacity: Option<usize>) -> Self {
        match old_capacity {
            Some(old_capacity) if old_capacity <= N => Self::default(),
            _ => StorageWithCapacity::<U>::with_capacity(capacity),
        }
    }
}

unsafe impl<U, T, const N: usize> Storage<U> for UninitArray<T, N> {
    #[doc(hidden)]
    const CONST_CAPACITY: Option<usize> = Some(crate::raw::capacity(N, size_of::<T>(), size_of::<U>()));

    fn is_valid_storage() -> bool { true }

    fn capacity(&self) -> usize { <Self as Storage<U>>::CONST_CAPACITY.unwrap() }

    fn as_ptr(&self) -> *const U { self.0.as_ptr().cast() }

    fn as_mut_ptr(&mut self) -> *mut U { self.0.as_mut_ptr().cast() }

    fn reserve(&mut self, new_capacity: usize) {
        let new_capacity = crate::raw::capacity(new_capacity, size_of::<U>(), size_of::<T>());
        if new_capacity > N {
            crate::raw::fixed_capacity_reserve_error(N, new_capacity)
        }
    }

    fn try_reserve(&mut self, capacity: usize) -> Result<(), AllocError> {
        if capacity <= N {
            Ok(())
        } else {
            Err(AllocError)
        }
    }
}

unsafe impl<T: Copy, const N: usize> crate::raw::StorageInit<T> for Array<T, N> {}
impl<T: Default + Copy, const N: usize> StorageWithCapacity<T> for Array<T, N> {
    fn with_capacity(capacity: usize) -> Self {
        if capacity > N {
            crate::raw::fixed_capacity_reserve_error(N, capacity)
        }

        Self::default()
    }

    #[inline]
    #[doc(hidden)]
    #[allow(non_snake_case)]
    fn __with_capacity__const_capacity_checked(capacity: usize, old_capacity: Option<usize>) -> Self {
        match old_capacity {
            Some(old_capacity) if old_capacity <= N => Self::default(),
            _ => Self::with_capacity(capacity),
        }
    }
}

unsafe impl<T: Copy, const N: usize> Storage<T> for Array<T, N> {
    #[doc(hidden)]
    const CONST_CAPACITY: Option<usize> = Some(N);

    fn is_valid_storage() -> bool { true }

    fn capacity(&self) -> usize { N }

    fn as_ptr(&self) -> *const T { self.0.as_ptr().cast() }

    fn as_mut_ptr(&mut self) -> *mut T { self.0.as_mut_ptr().cast() }

    fn reserve(&mut self, capacity: usize) {
        if capacity > N {
            crate::raw::fixed_capacity_reserve_error(N, capacity)
        }
    }

    fn try_reserve(&mut self, capacity: usize) -> Result<(), AllocError> {
        if capacity <= N {
            Ok(())
        } else {
            Err(AllocError)
        }
    }
}