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

use std::{marker, pin};

use cycle::Policy;

use crate::depot::arena::slab::{
    entries,
    key::{self, cycle},
    storage,
};

/// One reserved slot of a pinned store awaiting its first value.
///
/// The pinned owner forwards its own lifetime and tag; the free list and the
/// generation check stay in o3 so both storage policies share them.
pub struct Anchor<
    'a,
    T,
    Tag = (),
    const MAX: u32 = { u32::MAX },
    const RECYCLE: bool = false,
    const PARTITIONS: usize = 1,
    S = storage::Heap,
> where
    cycle::Mode<RECYCLE>: Policy,
    S: storage::Storage,
{
    pub(in crate::depot::arena::slab) entry:
        entries::Pending<'a, T, MAX, entries::Exclusive<RECYCLE>, PARTITIONS, (), S>,
    pub(in crate::depot::arena::slab) tag: marker::PhantomData<fn() -> Tag>,
}

impl<'a, T, Tag, const MAX: u32, const RECYCLE: bool, const PARTITIONS: usize, S>
    Anchor<'a, T, Tag, MAX, RECYCLE, PARTITIONS, S>
where
    cycle::Mode<RECYCLE>: Policy,
    S: storage::Storage,
{
    pub fn index(&self) -> u32 {
        self.entry.index().raw()
    }

    fn key(&self) -> key::Handle<Tag, MAX> {
        key::Handle::new(self.index(), self.entry.generation())
    }

    /// Installs the first value and returns its identity.
    pub fn insert(self, value: T) -> key::Handle<Tag, MAX> {
        let key = self.key();
        drop(self.entry.install(value));
        key
    }

    /// Installs the first value and projects it at its final address.
    pub fn occupy(self, value: T) -> (key::Handle<Tag, MAX>, pin::Pin<&'a mut T>) {
        let key = self.key();
        let busy = self.entry.install(value);
        // SAFETY: the installed value stays at this slot address for the pinned
        // owner's full returned loan; the exclusive slot exposes no move-out API.
        (key, unsafe { pin::Pin::new_unchecked(busy.into_mut()) })
    }
}