o3 0.34.2

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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

pub use error::Error;

use crate::depot::{
    array::Index,
    map::direct,
    queue::{indexed::lanes, links},
};

mod error;

/// One native direct-table slot and the queue topology governed by the same borrow.
pub struct Slot<'a, B, const N: usize> {
    slot: B,
    queues: &'a [links::Chain; N],
}

/// A removed value's exact slot and original FIFO position.
#[must_use = "an unrestored withdrawal leaves its value removed"]
pub struct Withdrawn<'a, K: crate::depot::raw::Key, V, const N: usize, S: lanes::raw::State<V> = ()>
{
    slot: direct::Vacant<'a, K, lanes::Node<V, N, S>>,
    queues: &'a [links::Chain; N],
    lane: Option<Index<N>>,
    hook: links::Hook,
}

impl<'a, B, const N: usize> Slot<'a, B, N> {
    pub(in crate::depot) fn new(slot: B, queues: &'a [links::Chain; N]) -> Self {
        Self { slot, queues }
    }
}

impl<'a, K: crate::depot::raw::Key, V, const N: usize, S: lanes::raw::State<V>>
    Occupied<'a, K, V, N, S>
{
    pub fn get(&self) -> &V {
        &self.slot.get().value
    }

    pub fn get_mut(&mut self) -> &mut V {
        &mut self.slot.get_mut().value
    }

    pub fn into_mut(self) -> &'a mut V {
        &mut self.slot.into_mut().value
    }

    pub(in crate::depot) fn state(&self) -> S {
        self.slot.get().state
    }

    pub fn move_to_back(self, target: Index<N>) {
        let index = unsafe { links::Index::new_usize(self.slot.index()) };
        // SAFETY: the retained occupied key proves this exact initialized node.
        let node = unsafe { self.slot.table().value(index) };
        let queue = target.get(self.queues);
        match node.lane.get() {
            Some(source) => {
                if source == target && queue.last() == Some(index) {
                    return;
                }
                unsafe {
                    source
                        .get(self.queues)
                        .move_back(queue, self.slot.table(), index);
                }
            }
            None => unsafe { queue.link_back(self.slot.table(), index) },
        }
        node.lane.set(Some(target));
    }

    pub fn unlink(self) {
        let index = unsafe { links::Index::new_usize(self.slot.index()) };
        // SAFETY: the retained occupied key proves this exact initialized node.
        let node = unsafe { self.slot.table().value(index) };
        if let Some(source) = node.lane.get() {
            unsafe {
                source
                    .get(self.queues)
                    .unlink(self.slot.table(), index)
                    .idle();
            }
            node.lane.set(None);
        }
    }

    /// Removes the value while retaining its exact key and original position.
    pub(in crate::depot) fn take_owned(
        self,
    ) -> (Withdrawn<'a, K, V, N, S>, lanes::raw::Owned<V, S>) {
        let index = self.detach();
        // SAFETY: unlink retained the exact entry and the pre-resolved index.
        let (slot, node) = unsafe { self.slot.take_at(index) };
        let (lane, hook, value) = node.unpack();
        (
            Withdrawn {
                slot,
                queues: self.queues,
                lane,
                hook,
            },
            value,
        )
    }

    pub fn discard(self) {
        let index = self.detach();
        // SAFETY: unlink retained the exact occupied entry and resolved index.
        unsafe { self.slot.discard_at(index) };
    }

    pub fn key(&self) -> K {
        self.slot.key()
    }

    pub fn lane(&self) -> Option<Index<N>> {
        self.slot.get().lane.get()
    }

    fn detach(&self) -> links::Index {
        // SAFETY: this occupied key was admitted within its exact u32-sized table.
        let index = unsafe { links::Index::new_usize(self.slot.index()) };
        let lane = unsafe { self.slot.table().value(index) }.lane.get();
        if let Some(lane) = lane {
            // SAFETY: this occupied entry retains its exact reciprocal lane.
            unsafe {
                lane.get(self.queues).unlink(self.slot.table(), index);
            }
        }
        index
    }
}

impl<'a, K: crate::depot::raw::Key, V, const N: usize> Occupied<'a, K, V, N> {
    pub fn remove(self) -> V {
        self.take_owned().1.into_value()
    }

    pub fn take(self) -> (Withdrawn<'a, K, V, N>, V) {
        let (slot, value) = self.take_owned();
        (slot, value.into_value())
    }
}

impl<'a, K: crate::depot::raw::Key, V, const N: usize, S: lanes::raw::State<V>>
    Withdrawn<'a, K, V, N, S>
{
    /// Restores the exact original lane and FIFO position without another lookup.
    pub(in crate::depot) fn restore_with(
        self,
        value: lanes::raw::Owned<V, S>,
    ) -> Occupied<'a, K, V, N, S> {
        // SAFETY: the retained vacancy belongs to this exact u32-sized table.
        let index = unsafe { links::Index::new_usize(self.slot.key().index()) };
        let slot = self
            .slot
            .insert(lanes::Node::from_parts(self.lane, self.hook, value));
        if let Some(lane) = self.lane {
            // SAFETY: this vacancy retained the exclusive table borrow and the
            // original hook, so its two neighbors still bound the same gap.
            unsafe {
                crate::depot::raw::Detach::restore(lane.get(self.queues), slot.table(), index);
            }
        }
        Slot::new(slot, self.queues)
    }

    /// Inserts the successor unlinked, ready for its selected destination.
    pub(in crate::depot) fn insert_with(
        self,
        value: lanes::raw::Owned<V, S>,
    ) -> Occupied<'a, K, V, N, S> {
        Slot::new(self.slot, self.queues).insert_with(value)
    }
}

impl<'a, K: crate::depot::raw::Key, V, const N: usize> Withdrawn<'a, K, V, N> {
    pub fn restore(self, value: V) -> Occupied<'a, K, V, N> {
        self.restore_with(lanes::raw::Owned::new(value))
    }

    pub fn insert(self, value: V) -> Occupied<'a, K, V, N> {
        self.insert_with(lanes::raw::Owned::new(value))
    }
}

impl<'a, K: crate::depot::raw::Key, V, const N: usize, S: lanes::raw::State<V>>
    Vacancy<'a, K, V, N, S>
{
    pub(in crate::depot) fn insert_with(
        self,
        value: lanes::raw::Owned<V, S>,
    ) -> Occupied<'a, K, V, N, S> {
        // SAFETY: the retained vacancy lies inside its original u32-sized table.
        let index = unsafe { links::Index::new_usize(self.slot.key().index()) };
        let slot = self.slot.insert(lanes::Node::new(index, value));
        Slot::new(slot, self.queues)
    }
}

impl<'a, K: crate::depot::raw::Key, V, const N: usize> Vacancy<'a, K, V, N> {
    pub fn insert(self, value: V) -> Occupied<'a, K, V, N> {
        self.insert_with(lanes::raw::Owned::new(value))
    }
}

pub type Occupied<'a, K, V, const N: usize, S = ()> =
    Slot<'a, direct::Occupied<'a, K, lanes::Node<V, N, S>>, N>;

/// A table vacancy retains the value reservation and all lane metadata.
pub type Vacancy<'a, K, V, const N: usize, S = ()> =
    Slot<'a, direct::Vacant<'a, K, lanes::Node<V, N, S>>, N>;