o3 0.20.1

shared-nothing primitives
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

use crate::{
    depot,
    depot::index::{bitmap, bitmap::entry::Row},
};

/// # Safety
/// Planes stay stationary and initialized with exact shapes, zero tail bits, and exact nonzero-child summaries.
/// Mutation preserves this; projections return normally without mutation or reentry.
pub unsafe trait Words<W: bitmap::Width = usize> {
    type Plane: Copy;
    type Size: bitmap::Size;

    fn shape(&self) -> bitmap::Shape<Self::Size, W>;
    fn words(&self, plane: Self::Plane) -> &[bitmap::Word<W>];

    fn row(entry: Row<&Self, (), (), W>, plane: Self::Plane) -> &[bitmap::Word<W>]
    where
        Self: Sized,
    {
        (*entry.source()).words(plane)
    }
}

// SAFETY: the borrow retains the same source, planes, and immutable shape.
unsafe impl<W: bitmap::Width, S: Words<W>> Words<W> for &S {
    type Plane = S::Plane;
    type Size = S::Size;

    fn shape(&self) -> bitmap::Shape<Self::Size, W> {
        S::shape(self)
    }

    fn words(&self, plane: Self::Plane) -> &[bitmap::Word<W>] {
        S::words(self, plane)
    }
    fn row(entry: Row<&Self, (), (), W>, plane: Self::Plane) -> &[bitmap::Word<W>] {
        // SAFETY: dereferencing this borrow preserves its exact source and bound.
        S::row(
            unsafe { depot::raw::Rows::map_row(entry, |source| *source) },
            plane,
        )
    }
}

// SAFETY: the exclusive borrow retains the same stationary source and planes.
unsafe impl<W: bitmap::Width, S: Words<W>> Words<W> for &mut S {
    type Plane = S::Plane;
    type Size = S::Size;

    fn shape(&self) -> bitmap::Shape<Self::Size, W> {
        S::shape(self)
    }

    fn words(&self, plane: Self::Plane) -> &[bitmap::Word<W>] {
        S::words(self, plane)
    }
    fn row(entry: Row<&Self, (), (), W>, plane: Self::Plane) -> &[bitmap::Word<W>] {
        // SAFETY: this reborrow retains the original exclusive owner's domain.
        S::row(
            unsafe { depot::raw::Rows::map_row(entry, |source| &**source) },
            plane,
        )
    }
}