building_blocks_storage 0.7.1

Efficient storage for maps on sparse or dense, 2D and 3D integer lattices.
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
147

use core::mem::MaybeUninit;

/// Used for variadic conversion from `&(A, B, ...)` to `(&A, &B, ...)`.
#[doc(hidden)]
pub trait MultiRef<'a> {
    type Data;

    fn from_data_ref(data_ref: &'a Self::Data) -> Self;
}

impl<'a, T> MultiRef<'a> for &'a T {
    type Data = T;

    #[inline]
    fn from_data_ref(data_ref: &'a Self::Data) -> Self {
        data_ref
    }
}

/// Used for variadic conversion from `(*mut A, *mut B, ...)` to `(&'a mut A, &'a mut B, ...)`.
#[doc(hidden)]
pub trait IntoMultiMut<'a> {
    type MultiMut;

    fn into_multi_mut(self) -> Self::MultiMut;
}

impl<'a, T> IntoMultiMut<'a> for *mut T
where
    T: 'a,
{
    type MultiMut = &'a mut T;

    #[inline]
    fn into_multi_mut(self) -> Self::MultiMut {
        unsafe { &mut *self }
    }
}

/// Used for variadic conversion from `(*mut MaybeUninit<A>, *mut MaybeUninit<B>, ...)` to `(*mut A, *mut B)`.
#[doc(hidden)]
pub trait IntoMultiMutPtr {
    type Data;
    type Ptr: MultiMutPtr<Data = Self::Data>;

    /// # Safety
    /// `Self::Ptr` is intended to contain `*mut` pointers, so this carries the same safety concerns as any such pointer.
    unsafe fn into_multi_mut_ptr(self) -> Self::Ptr;
}

impl<T> IntoMultiMutPtr for *mut MaybeUninit<T> {
    type Data = T;
    type Ptr = *mut T;

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

/// Used for variadic copying of source data `(A, B, ...)` to destination pointers `(*mut A, *mut B, ...)`.
#[doc(hidden)]
pub trait MultiMutPtr {
    type Data;

    /// # Safety
    /// `self` is intended to contain `*mut` pointers, so this carries the same safety concerns as any such pointer.
    unsafe fn write(self, data: Self::Data);
}

impl<T> MultiMutPtr for *mut T {
    type Data = T;

    #[inline]
    unsafe fn write(self, data: Self::Data) {
        *self = data;
    }
}

macro_rules! impl_tuple {
    ( $( $var1:ident, $var2:ident : $t:ident ),+ ) => {
        impl<'a, $($t),+> MultiRef<'a> for ($($t,)+)
        where
            $($t: 'a + MultiRef<'a>,)+
        {
            type Data = ($($t::Data,)+);

            #[inline]
            fn from_data_ref(data_ref: &'a Self::Data) -> Self {
                let ($($var1,)+) = data_ref;

                ($($t::from_data_ref($var1),)+)
            }
        }

        impl<'a, $($t),+> IntoMultiMut<'a> for ($(*mut $t,)+)
        where
            $($t: 'a,)+
        {
            type MultiMut = ($(&'a mut $t,)+);

            #[inline]
            fn into_multi_mut(self) -> Self::MultiMut {
                let ($($var1,)+) = self;

                unsafe { ($(&mut *$var1,)+) }
            }
        }

        impl<$($t),+> IntoMultiMutPtr for ($($t,)+)
        where
            $($t: IntoMultiMutPtr),+
        {
            type Data = ($($t::Data,)+);
            type Ptr = ($($t::Ptr,)+);

            #[inline]
            unsafe fn into_multi_mut_ptr(self) -> Self::Ptr {
                let ($($var1,)+) = self;

                ($($var1.into_multi_mut_ptr(),)+)
            }
        }

        impl<$($t),+> MultiMutPtr for ($($t,)+)
        where
            $($t: MultiMutPtr,)+
        {
            type Data = ($($t::Data,)+);

            #[inline]
            unsafe fn write(self, data: Self::Data) {
                let ($($var1,)+) = self;
                let ($($var2,)+) = data;

                $( $var1.write($var2); )+
            }
        }
    };
}

impl_tuple! { a1, a2: A }
impl_tuple! { a1, a2: A, b1, b2: B }
impl_tuple! { a1, a2: A, b1, b2: B, c1, c2: C }
impl_tuple! { a1, a2: A, b1, b2: B, c1, c2: C, d1, d2: D }
impl_tuple! { a1, a2: A, b1, b2: B, c1, c2: C, d1, d2: D, e1, e2: E }
impl_tuple! { a1, a2: A, b1, b2: B, c1, c2: C, d1, d2: D, e1, e2: E, f1, f2: F }