no_std_collections 0.1.1

Auxiliary structures and traits for using dynamically resizable arrays (Vectors) in flexible environments, supporting both std and no_std contexts.
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

use super::SliceOwner;

#[inline]
#[track_caller]
fn slice_end_index_len_fail(index: usize, len: usize) -> ! {
    panic!("range end index {index} out of range for slice of length {len}");
}

pub unsafe trait Ops: SliceOwner {
    #[inline(always)]
    fn is_empty(&self) -> bool {
        self.len() == 0
    }

    #[inline]
    unsafe fn get_unchecked(&self, index: usize) -> &Self::Item {
        &*self.as_ptr().add(index)
    }

    #[inline]
    fn get(&self, index: usize) -> &Self::Item {
        if index > self.len() {
            slice_end_index_len_fail(index, self.len());
        }

        unsafe { self.get_unchecked(index) }
    }

    #[inline(always)]
    unsafe fn first_unchecked(&self) -> &Self::Item {
        &*self.as_ptr()
    }

    #[inline(always)]
    unsafe fn first_mut_unchecked(&mut self) -> &mut Self::Item {
        &mut *self.as_mut_ptr()
    }

    #[inline]
    fn first(&self) -> Option<&Self::Item> {
        if self.is_empty() {
            None
        } else {
            Some(unsafe { self.first_unchecked() })
        }
    }

    #[inline]
    fn first_mut(&mut self) -> Option<&mut Self::Item> {
        if self.is_empty() {
            None
        } else {
            Some(unsafe { self.first_mut_unchecked() })
        }
    }

    #[inline(always)]
    unsafe fn last_unchecked(&self) -> &Self::Item {
        &*self.as_ptr().add(self.len().unchecked_sub(1))
    }

    #[inline(always)]
    unsafe fn last_mut_unchecked(&mut self) -> &mut Self::Item {
        &mut *self.as_mut_ptr().add(self.len().unchecked_sub(1))
    }

    #[inline]
    fn last(&self) -> Option<&Self::Item> {
        if self.is_empty() {
            None
        } else {
            Some(unsafe { self.last_unchecked() })
        }
    }

    #[inline]
    fn last_mut(&mut self) -> Option<&mut Self::Item> {
        if self.is_empty() {
            None
        } else {
            Some(unsafe { self.last_mut_unchecked() })
        }
    }

    unsafe fn split_at_unchecked(&self, mid: usize) -> (&[Self::Item], &[Self::Item]) {
        let len = self.len();
        let ptr = self.as_ptr();
        unsafe {
            (
                core::slice::from_raw_parts(ptr, mid),
                core::slice::from_raw_parts(ptr.add(mid), len.unchecked_sub(mid)),
            )
        }
    }

    unsafe fn split_at_mut_unchecked(
        &mut self,
        mid: usize,
    ) -> (&mut [Self::Item], &mut [Self::Item]) {
        let len = self.len();
        let ptr = self.as_mut_ptr();
        unsafe {
            (
                core::slice::from_raw_parts_mut(ptr, mid),
                core::slice::from_raw_parts_mut(ptr.add(mid), len.unchecked_sub(mid)),
            )
        }
    }

    #[inline]
    fn split_at_checked(&self, mid: usize) -> Option<(&[Self::Item], &[Self::Item])> {
        if mid <= self.len() {
            Some(unsafe { self.split_at_unchecked(mid) })
        } else {
            None
        }
    }

    #[inline]
    fn split_at_mut_checked(
        &mut self,
        mid: usize,
    ) -> Option<(&mut [Self::Item], &mut [Self::Item])> {
        if mid <= self.len() {
            Some(unsafe { self.split_at_mut_unchecked(mid) })
        } else {
            None
        }
    }

    #[inline]
    fn split_at(&self, mid: usize) -> (&[Self::Item], &[Self::Item]) {
        match self.split_at_checked(mid) {
            Some(pair) => pair,
            None => panic!("mid > len"),
        }
    }

    #[inline]
    fn split_at_mut(&mut self, mid: usize) -> (&mut [Self::Item], &mut [Self::Item]) {
        match self.split_at_mut_checked(mid) {
            Some(pair) => pair,
            None => panic!("mid > len"),
        }
    }
}