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

//! GhostCell-style cells with tagged permissions and pin-aware borrowing.
//! Based on <https://plv.mpi-sws.org/rustbelt/ghostcell/>.

use std::{cell, marker, pin};

type Invariant<'id> = marker::PhantomData<*mut &'id ()>;
type Tagged<Tag> = marker::PhantomData<fn(Tag) -> Tag>;

#[doc(hidden)]
pub enum BrandPermission {}

#[doc(hidden)]
pub enum RegionPermission {}

pub struct Token<'id, Tag> {
    _brand: Invariant<'id>,
    _tag: Tagged<Tag>,
}

#[repr(transparent)]
pub struct Branded<'id, T, Tag> {
    value: cell::UnsafeCell<T>,
    _brand: Invariant<'id>,
    _tag: Tagged<Tag>,
}

pub type BrandToken<'id> = Token<'id, BrandPermission>;

pub type Brand<'id, T> = Branded<'id, T, BrandPermission>;

pub type RegionToken<'id> = Token<'id, RegionPermission>;

pub type Region<'id, T> = Branded<'id, T, RegionPermission>;

impl Token<'_, BrandPermission> {
    pub fn scope_with_region<R>(
        f: impl for<'id> FnOnce(BrandToken<'id>, RegionToken<'id>) -> R,
    ) -> R {
        f(Token::new(), Token::new())
    }
}

impl<Tag> Token<'_, Tag> {
    pub fn scope<R>(f: impl for<'id> FnOnce(Token<'id, Tag>) -> R) -> R {
        f(Token::new())
    }

    const fn new() -> Self {
        Self {
            _brand: marker::PhantomData,
            _tag: marker::PhantomData,
        }
    }
}

impl<'id, T, Tag> Branded<'id, T, Tag> {
    pub const fn new(value: T) -> Self {
        Self {
            value: cell::UnsafeCell::new(value),
            _brand: marker::PhantomData,
            _tag: marker::PhantomData,
        }
    }

    pub fn borrow<'a>(&'a self, token: &'a Token<'id, Tag>) -> &'a T {
        let _ = token;
        unsafe { &*self.value.get() }
    }

    pub fn borrow_mut<'a>(&'a self, token: &'a mut Token<'id, Tag>) -> &'a mut T
    where
        T: Unpin,
    {
        let _ = token;
        unsafe { &mut *self.value.get() }
    }

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

    pub fn into_inner(self) -> T {
        self.value.into_inner()
    }

    pub fn borrow_pin_mut<'a>(
        self: pin::Pin<&'a Self>,
        token: &'a mut Token<'id, Tag>,
    ) -> pin::Pin<&'a mut T> {
        let _ = token;
        unsafe { pin::Pin::new_unchecked(&mut *self.get_ref().value.get()) }
    }

    pub fn borrow_pin<'a>(self: pin::Pin<&'a Self>, token: &'a Token<'id, Tag>) -> pin::Pin<&'a T> {
        unsafe { pin::Pin::new_unchecked(self.get_ref().borrow(token)) }
    }
}