o3 0.22.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
56
57
58
59
60
61
62
63
64
65
66
67
68
69

use std::{mem, ops, ptr};

use crate::alloc::{self, tail};

/// Ownership of one allocated header-and-tail layout before initialization.
#[must_use = "initialize the allocation or release it"]
pub struct Uninit<H, T, N: alloc::raw::TailExtent = usize> {
    pub(in crate::alloc::tail) memory: ptr::NonNull<u8>,
    pub(in crate::alloc::tail) layout: tail::Plan<H, T, N>,
}

impl<H, T, N: alloc::raw::TailExtent> Uninit<H, T, N> {
    pub fn fill(self, header: H, mut init: impl FnMut(&H, N::Index) -> T) -> tail::Block<H, T, N> {
        let mut block = self.init(header);
        let indices = block.extent().indices();
        let (header, tail) = block.parts_mut();
        let header: &H = header;
        for (index, slot) in indices.zip(tail) {
            slot.write(init(header, index));
        }
        // SAFETY: the exact extent visited and initialized every tail slot.
        unsafe { block.assume_init() }
    }

    pub fn repeat(self, header: H, value: T) -> tail::Block<H, T, N>
    where
        T: Copy,
    {
        self.repeat_with(header, || value)
    }

    pub fn repeat_with(self, header: H, mut init: impl FnMut() -> T) -> tail::Block<H, T, N> {
        let mut block = self.init(header);
        alloc::raw::init(block.as_mut_slice(), |_| init());
        // SAFETY: every tail slot now contains one initialized element.
        unsafe { block.assume_init() }
    }

    /// Initializes the header while retaining the tail as uninitialized storage.
    pub fn init(self, header: H) -> tail::Block<H, mem::MaybeUninit<T>, N> {
        let this = mem::ManuallyDrop::new(self);
        let pointer = this.memory.cast::<tail::Prefix<H, T, N>>();
        // SAFETY: the allocation uses the exact combined layout, is uniquely
        // owned, and its prefix is currently uninitialized.
        unsafe {
            pointer.as_ptr().write(tail::Prefix {
                header,
                len: this.layout,
            })
        };
        tail::Block {
            pointer: pointer.cast(),
        }
    }
}

impl<H, T, N: alloc::raw::TailExtent> Drop for Uninit<H, T, N> {
    fn drop(&mut self) {
        // SAFETY: this state owns the exact allocation and has initialized no value.
        unsafe { alloc::raw::LayoutExt::deallocate(self.layout.layout(), self.memory) };
    }
}

impl<H, T> Uninit<H, T> {
    /// Initializes the immovable header and lends each tail write in order.
    pub fn start(self, header: H) -> ops::ControlFlow<tail::Block<H, T>, tail::Entry<H, T>> {
        tail::Entry::new(self.init(header))
    }
}