generic-array 1.4.3

Generic types implementing functionality of arrays
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

//! Const default implementation

use crate::{ArrayLength, GenericArray, GenericArrayImplEven, GenericArrayImplOdd};
use const_default::ConstDefault;

impl<T, U: ConstDefault> ConstDefault for GenericArrayImplEven<T, U> {
    const DEFAULT: Self = Self {
        parents: [U::DEFAULT; 2],
        _marker: core::marker::PhantomData,
    };
}

impl<T: ConstDefault, U: ConstDefault> ConstDefault for GenericArrayImplOdd<T, U> {
    const DEFAULT: Self = Self {
        parents: [U::DEFAULT; 2],
        data: T::DEFAULT,
    };
}

impl<T, U: ArrayLength> ConstDefault for GenericArray<T, U>
where
    U::ArrayType<T>: ConstDefault,
{
    const DEFAULT: Self = Self {
        data: ConstDefault::DEFAULT,
    };
}

// `T: ConstDefault` is intentionally redundant to provide better hints in the docs
impl<T: ConstDefault, U: ArrayLength> GenericArray<T, U>
where
    Self: ConstDefault,
{
    /// Returns the constant "default value" for an array using [ConstDefault]
    #[inline(always)]
    pub const fn const_default() -> Self {
        Self::DEFAULT
    }
}

#[cfg(test)]
mod tests {
    use crate::{arr, typenum::U4, GenericArray};
    use const_default::ConstDefault;

    #[test]
    fn const_default_works() {
        // Use runtime (non-`const`) bindings: a `const` context is evaluated at
        // compile time and so is invisible to runtime coverage instrumentation.

        // exercises the recursive `GenericArrayImplEven`/`Odd` and `GenericArray` DEFAULT consts
        let a: GenericArray<i32, U4> = <GenericArray<i32, U4> as ConstDefault>::DEFAULT;
        assert_eq!(a, arr![0, 0, 0, 0]);

        // and the `const_default()` convenience accessor
        let b: GenericArray<i32, U4> = GenericArray::const_default();
        assert_eq!(b, arr![0, 0, 0, 0]);
    }
}