arrayvec/
array.rs

1
2/// Trait for fixed size arrays.
3///
4/// This trait is implemented for some specific array sizes, see
5/// the implementor list below. At the current state of Rust we can't
6/// make this fully general for every array size.
7///
8/// The following crate features add more array sizes (and they are not
9/// enabled by default due to their impact on compliation speed).
10///
11/// - `array-sizes-33-128`: All sizes 33 to 128 are implemented
12///   (a few in this range are included by default).
13/// - `array-sizes-129-255`: All sizes 129 to 255 are implemented
14///   (a few in this range are included by default).
15///
16/// ## Safety
17///
18/// This trait can *only* be implemented by fixed-size arrays or types with
19/// *exactly* the representation of a fixed size array (of the right element
20/// type and capacity).
21///
22/// Normally this trait is an implementation detail of arrayvec and doesn’t
23/// need implementing.
24pub unsafe trait Array {
25    /// The array’s element type
26    type Item;
27    /// The smallest type that can index and tell the length of the array.
28    #[doc(hidden)]
29    type Index: Index;
30    /// The array's element capacity
31    const CAPACITY: usize;
32    fn as_slice(&self) -> &[Self::Item];
33    fn as_mut_slice(&mut self) -> &mut [Self::Item];
34}
35
36pub trait Index : PartialEq + Copy {
37    const ZERO: Self;
38    fn to_usize(self) -> usize;
39    fn from(_: usize) -> Self;
40}
41
42impl Index for () {
43    const ZERO: Self = ();
44    #[inline(always)]
45    fn to_usize(self) -> usize { 0 }
46    #[inline(always)]
47    fn from(_ix: usize) ->  Self { () }
48}
49
50impl Index for bool {
51    const ZERO: Self = false;
52    #[inline(always)]
53    fn to_usize(self) -> usize { self as usize }
54    #[inline(always)]
55    fn from(ix: usize) ->  Self { ix != 0 }
56}
57
58impl Index for u8 {
59    const ZERO: Self = 0;
60    #[inline(always)]
61    fn to_usize(self) -> usize { self as usize }
62    #[inline(always)]
63    fn from(ix: usize) ->  Self { ix as u8 }
64}
65
66impl Index for u16 {
67    const ZERO: Self = 0;
68    #[inline(always)]
69    fn to_usize(self) -> usize { self as usize }
70    #[inline(always)]
71    fn from(ix: usize) ->  Self { ix as u16 }
72}
73
74impl Index for u32 {
75    const ZERO: Self = 0;
76    #[inline(always)]
77    fn to_usize(self) -> usize { self as usize }
78    #[inline(always)]
79    fn from(ix: usize) ->  Self { ix as u32 }
80}
81
82impl Index for usize {
83    const ZERO: Self = 0;
84    #[inline(always)]
85    fn to_usize(self) -> usize { self }
86    #[inline(always)]
87    fn from(ix: usize) ->  Self { ix }
88}
89
90macro_rules! fix_array_impl {
91    ($index_type:ty, $len:expr ) => (
92        unsafe impl<T> Array for [T; $len] {
93            type Item = T;
94            type Index = $index_type;
95            const CAPACITY: usize = $len;
96            #[doc(hidden)]
97            fn as_slice(&self) -> &[Self::Item] { self }
98            #[doc(hidden)]
99            fn as_mut_slice(&mut self) -> &mut [Self::Item] { self }
100        }
101    )
102}
103
104macro_rules! fix_array_impl_recursive {
105    ($index_type:ty, ) => ();
106    ($index_type:ty, $($len:expr,)*) => (
107        $(fix_array_impl!($index_type, $len);)*
108    );
109}
110
111
112fix_array_impl_recursive!((), 0,);
113fix_array_impl_recursive!(bool, 1,);
114fix_array_impl_recursive!(u8, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
115                          15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27,
116                          28, 29, 30, 31, );
117
118#[cfg(not(feature="array-sizes-33-128"))]
119fix_array_impl_recursive!(u8, 32, 40, 48, 50, 56, 64, 72, 96, 100, 128, );
120
121#[cfg(feature="array-sizes-33-128")]
122fix_array_impl_recursive!(u8, 
12332, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51,
12452, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71,
12572, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91,
12692, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108,
127109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124,
128125, 126, 127, 128,
129);
130
131#[cfg(not(feature="array-sizes-129-255"))]
132fix_array_impl_recursive!(u8, 160, 192, 200, 224,);
133
134#[cfg(feature="array-sizes-129-255")]
135fix_array_impl_recursive!(u8,
136129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140,
137141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156,
138157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172,
139173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188,
140189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204,
141205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220,
142221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236,
143237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252,
144253, 254, 255,
145);
146
147fix_array_impl_recursive!(u16, 256, 384, 512, 768, 1024, 2048, 4096, 8192, 16384, 32768,);
148// This array size doesn't exist on 16-bit
149#[cfg(any(target_pointer_width="32", target_pointer_width="64"))]
150fix_array_impl_recursive!(u32, 1 << 16,);
151