o3 0.24.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
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

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

use crate::depot::arena::{linked, linked::slots};

/// Sole return entitlement, retaining the allocation's original owner.
#[must_use = "a vacant slot retains its sole return entitlement"]
pub struct Vacant<T, H: linked::Source<T>, Tag = ()> {
    pub(super) owner: H,
    pub(super) index: slots::Index<Tag>,
    pub(super) value: marker::PhantomData<T>,
}

impl<T, H: linked::Source<T>, Tag> Vacant<T, H, Tag> {
    /// # Safety
    /// This exact owner has one available slot.
    pub(crate) unsafe fn reserve(owner: H) -> Self {
        let store = owner.store();
        if H::TRACK {
            store.available.set(store.available.get().wrapping_sub(1));
        }
        unsafe { Self::claim(owner) }
    }

    /// # Safety
    /// One already debited reservation is consumed from this exact store.
    pub(in crate::depot::arena::linked) unsafe fn claim(owner: H) -> Self {
        let (index, _) = unsafe { owner.store().claim::<false>() };
        Self {
            owner,
            index: slots::Index::new(index),
            value: marker::PhantomData,
        }
    }

    /// # Safety
    /// This exact owner has one available slot.
    pub(crate) unsafe fn insert_one(owner: H, value: T) -> slots::Live<T, H, Tag> {
        let store = owner.store();
        if H::TRACK {
            store.available.set(store.available.get().wrapping_sub(1));
        }
        let (index, node) = unsafe { store.claim::<true>() };
        unsafe { node.value.get().cast::<T>().write(value) };
        slots::Live {
            vacant: Self {
                owner,
                index: slots::Index::new(index),
                value: marker::PhantomData,
            },
        }
    }

    pub fn insert(self, value: T) -> slots::Live<T, H, Tag> {
        let node = unsafe { self.owner.store().region.slot(self.index.raw()) };
        unsafe { node.value.get().cast::<T>().write(value) };
        node.next.set(slots::Store::<T>::END);
        slots::Live { vacant: self }
    }

    pub(crate) fn release(self) -> H {
        let owner = self.recycle();
        if H::TRACK {
            owner.store().refund(1);
        }
        owner
    }

    pub(in crate::depot::arena::linked) fn recycle(self) -> H {
        let this = mem::ManuallyDrop::new(self);
        let store = this.owner.store();
        let index = this.index.raw();
        let node = unsafe { store.region.slot(index) };
        store.recycle(index, node);
        unsafe { ptr::read(&this.owner) }
    }
}

impl<T, H: linked::Source<T>, Tag> Drop for Vacant<T, H, Tag> {
    fn drop(&mut self) {
        Vacant {
            owner: &self.owner,
            index: self.index,
            value: marker::PhantomData,
        }
        .release();
    }
}

impl<'a, T, Tag> Vacant<T, &'a slots::Store<T>, Tag> {
    /// # Safety
    /// The state's live partition belongs to this vacancy's exact store
    /// with the same `TRACK = true` accounting policy.
    pub(crate) unsafe fn bind<'b>(
        self,
        state: &'b mut slots::State<Tag>,
    ) -> Vacant<T, slots::Bound<'b, T, Tag>, Tag>
    where
        'a: 'b,
    {
        // Transfer the sole recycle/refund entitlement without releasing this vacancy.
        let this = mem::ManuallyDrop::new(self);
        Vacant {
            // SAFETY: the caller retains this store's exact partition and accounting policy.
            owner: unsafe { state.bind(this.owner) },
            index: this.index,
            value: marker::PhantomData,
        }
    }
}

impl<T, Tag, const TRACK: bool> crate::mem::Return
    for slots::Vacant<T, slots::Bound<'_, T, Tag, TRACK>, Tag>
{
    type Item = T;

    fn return_item(self, item: T) {
        self.insert(item).prepend();
    }
}