libutils-array 0.2.0

A maximum-sized array stored on the stack
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

//^
//^ HEAD
//^

//> HEAD -> SUPER
use super::Array;

//> HEAD -> CORE
use core::{
    mem::{
        MaybeUninit,
        forget
    },
    slice::{
        Iter,
        IterMut
    },
    iter::{
        ExactSizeIterator,
        DoubleEndedIterator,
        FusedIterator,
        TrustedLen
    },
    marker::Destruct
};


//^
//^ ITERABLE
//^

//> ITERABLE -> STRUCT
pub struct Iterable<Type, const N: usize> {
    index: usize,
    reduced: usize,
    length: usize,
    data: MaybeUninit<[Type; N]>
} 

//> ITERABLE -> DROP
const impl<Type: [const] Destruct, const N: usize> Drop for Iterable<Type, N> {
    fn drop(&mut self) {while let Some(value) = self.next() {drop(value)}}
}

//> ITERABLE -> ITERATOR
const impl<Type, const N: usize> Iterator for Iterable<Type, N> {
    type Item = Type;
    fn next(&mut self) -> Option<Self::Item> {
        return if self.length - self.reduced - self.index == 0 {None} else {
            let value = unsafe {(self.data.as_ptr() as *const Type).add(self.index).read()};
            self.index += 1;
            Some(value)
        }
    }
    fn size_hint(&self) -> (usize, Option<usize>) {return (self.length - self.index, Some(self.length - self.index))}
}

//> ITERABLE -> EXACT SIZE
impl<Type, const N: usize> ExactSizeIterator for Iterable<Type, N> {}

//> ITERABLE -> DOUBLE ENDED
const impl<Type, const N: usize> DoubleEndedIterator for Iterable<Type, N> {
    fn next_back(&mut self) -> Option<Self::Item> {
        return if self.length - self.reduced - self.index == 0 {None} else {
            let value = unsafe {(self.data.as_ptr() as *const Type).add(self.length - 1 - self.reduced).read()};
            self.reduced += 1;
            Some(value)
        }
    }
}

//> ITERABLE -> FUSED
impl<Type, const N: usize> FusedIterator for Iterable<Type, N> {}

//> ITERABLE -> TRUSTED LEN
unsafe impl<Type, const N: usize> TrustedLen for Iterable<Type, N> {}


//^
//^ ITERATORS
//^

//> ITERATORS -> FROM
impl<Type, const N: usize> FromIterator<Type> for Array<Type, N> {
    fn from_iter<T: IntoIterator<Item = Type>>(iter: T) -> Self {
        let mut array = Self::new();
        array.extend(iter);
        return array;
    }
}

//> ITERATORS -> INTO
const impl<Type, const N: usize> IntoIterator for Array<Type, N> {
    type Item = Type;
    type IntoIter = Iterable<Type, N>;
    fn into_iter(self) -> Self::IntoIter {
        let iterator = Self::IntoIter {
            index: 0,
            reduced: 0,
            length: self.length,
            data: unsafe {MaybeUninit::new(self.data.as_ptr().read())}
        };
        forget(self);
        return iterator;
    }
}

//> ITERATORS -> BORROWED
const impl<'valid, Type, const N: usize> IntoIterator for &'valid Array<Type, N> {
    type Item = &'valid Type;
    type IntoIter = Iter<'valid, Type>;
    fn into_iter(self) -> Self::IntoIter {self.iter()}
}

//> ITERATORS -> BORROWED MUTABLY
const impl<'valid, Type, const N: usize> IntoIterator for &'valid mut Array<Type, N> {
    type Item = &'valid mut Type;
    type IntoIter = IterMut<'valid, Type>;
    fn into_iter(self) -> Self::IntoIter {self.iter_mut()}
}