o3 0.21.0

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

use std::{alloc::Layout, mem, num::NonZero};

use crate::alloc;

/// # Safety
/// Immutable members describe one representable allocation of aligned, disjoint Root/Tail/Extra/Last planes in order, starting Root at zero.
/// Offsets stay within `layout()`; every plane has `len()` elements except Tail, which has `tail_len()`.
pub unsafe trait Shape {
    type Root;
    type Tail;
    type Extra;
    type Last;

    fn is_empty(&self) -> bool {
        self.len() == 0
    }

    fn len(&self) -> usize;

    fn tail_len(&self) -> usize {
        self.len()
    }

    fn offset(&self) -> usize {
        let size = mem::size_of::<Self::Root>().wrapping_mul(self.len());
        // SAFETY: the retained Shape proves this aligned plane offset fits.
        unsafe { alloc::raw::Layout::<Self::Tail>::offset(size) }
    }

    fn extra(&self) -> usize {
        let size = self
            .offset()
            .wrapping_add(mem::size_of::<Self::Tail>().wrapping_mul(self.tail_len()));
        // SAFETY: the retained Shape proves this aligned plane offset fits.
        unsafe { alloc::raw::Layout::<Self::Extra>::offset(size) }
    }

    fn last(&self) -> usize {
        let size = self
            .extra()
            .wrapping_add(mem::size_of::<Self::Extra>().wrapping_mul(self.len()));
        // SAFETY: the retained Shape proves this aligned plane offset fits.
        unsafe { alloc::raw::Layout::<Self::Last>::offset(size) }
    }

    fn layout(&self) -> Layout {
        let align = mem::align_of::<Self::Root>()
            .max(mem::align_of::<Self::Tail>())
            .max(mem::align_of::<Self::Extra>());
        let align = NonZero::<usize>::MIN.saturating_add(align - 1);
        // SAFETY: the immutable typed extent proves this complete allocation.
        unsafe { alloc::raw::Layout::<Self::Last>::at(self.last(), self.len(), align) }
            .pad_to_align()
    }
}