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

//! Persistent lane proofs with exclusive mutation governed by one region token.

use std::num::NonZero;

use tagged::lane;

use crate::{
    base::cell::region,
    depot::{
        capacity,
        queue::{indexed::lanes::runtime, tagged},
    },
};

/// Immutable queue identity whose mutable topology belongs to one region.
pub struct Fifo<
    'id,
    T,
    C: crate::depot::raw::Count = capacity::Count,
    L: crate::depot::raw::Count = capacity::Count,
> {
    queue: region::Value<region::Identity<'id>, runtime::Fifo<T, C, L>>,
    lanes: L,
}

/// A checked endpoint retaining its exact queue owner and region brand.
pub struct Head<
    'a,
    'id,
    T,
    C: crate::depot::raw::Count = capacity::Count,
    L: crate::depot::raw::Count = capacity::Count,
> {
    owner: &'a Fifo<'id, T, C, L>,
    endpoint: NonZero<u32>,
}

impl<'id, T, C: crate::depot::raw::Count, L: crate::depot::raw::Count> Fifo<'id, T, C, L> {
    pub fn try_from(
        capacity: C,
        lanes: L,
        token: &region::Token<region::Identity<'id>>,
    ) -> Result<Self, tagged::Error<C, L>> {
        let queue = runtime::Fifo::try_from(capacity, lanes)?;
        Ok(Self {
            lanes: queue.lanes(),
            queue: token.bind(queue),
        })
    }

    pub fn head(&self, index: usize) -> Result<Head<'_, 'id, T, C, L>, lane::Error<L>> {
        let lanes = self.lanes;
        if index >= lanes.count().get() {
            return Err(lane::Error { lane: index, lanes });
        }
        // SAFETY: the immutable count came from this queue's validated allocation.
        let endpoint = unsafe { NonZero::new_unchecked(u32::MAX - index as u32) };
        Ok(Head {
            owner: self,
            endpoint,
        })
    }
}

impl<'a, 'id, T, C: crate::depot::raw::Count, L: crate::depot::raw::Count> Head<'a, 'id, T, C, L> {
    pub const fn index(&self) -> usize {
        (u32::MAX - self.endpoint.get()) as usize
    }

    pub fn borrow<'b>(
        &self,
        token: &'b mut region::Token<region::Identity<'id>>,
    ) -> tagged::Endpoint<&'b mut runtime::Fifo<T, C, L>>
    where
        'a: 'b,
    {
        let queue = token.borrow_mut(&self.owner.queue);
        // SAFETY: owner never exposes replacement of its queue or allocation shape.
        unsafe { tagged::Endpoint::new(queue, self.endpoint) }
    }

    pub fn take(
        &self,
        token: &mut region::Token<region::Identity<'id>>,
        index: usize,
        expected: T,
    ) -> Option<T>
    where
        T: Eq,
    {
        token.borrow_mut(&self.owner.queue).take(index, expected)
    }
}

const _: () = {
    assert!(size_of::<Fifo<'static, ()>>() == 4 * size_of::<usize>());
    assert!(size_of::<Head<'static, 'static, ()>>() == 2 * size_of::<usize>());
    assert!(
        size_of::<Option<Head<'static, 'static, ()>>>() == size_of::<Head<'static, 'static, ()>>()
    );
    assert!(
        size_of::<Fifo<'static, (), NonZero<u32>, NonZero<u32>>>()
            == size_of::<Fifo<'static, ()>>()
    );
    assert!(
        size_of::<Option<Head<'static, 'static, (), NonZero<u32>, NonZero<u32>>>>()
            == size_of::<Head<'static, 'static, ()>>()
    );
};