token-cell 3.0.0

A more convenient GhostCell
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

use core::convert::Infallible;

use crate::{
    core::{False, TokenGuard, TokenGuardMut, True, UnsafeTokenCellTrait},
    prelude::*,
};

/// An operation waiting to be applied onto a cell by providing a proof of immutable access.
#[must_use = "TokenMaps must be applied to do anything. Note that the closure execution will be deferred to the call-site of `apply/try_apply`"]
pub struct TokenMap<
    'a,
    T: ?Sized,
    U,
    F: FnOnce(TokenGuard<'a, T, Token>) -> U,
    Cell: ?Sized,
    Token: TokenTrait<ComparisonMaySpuriouslyEq = ComparisonMaySpuriouslyEq> + 'a,
    ComparisonMaySpuriouslyEq,
> {
    pub(crate) cell: &'a Cell,
    pub(crate) f: F,
    pub(crate) marker: core::marker::PhantomData<(&'a T, U, Token, ComparisonMaySpuriouslyEq)>,
}
impl<
        'a,
        T: ?Sized,
        U,
        F: FnOnce(TokenGuard<'a, T, Token>) -> U,
        Token: TokenTrait<ComparisonMaySpuriouslyEq = True>,
        Cell: UnsafeTokenCellTrait<T, Token>,
    > TokenMap<'a, T, U, F, Cell, Token, True>
{
    /// Attempt to apply the operation.
    ///
    /// # Errors
    /// If the token comparison failed. Reaching this error is likely to be a fundamental error in your program.
    pub fn try_apply(self, token: &'a Token) -> Result<U, (Self, Token::ComparisonError)> {
        match unsafe { self.cell.try_guard(token) } {
            Ok(borrowed) => Ok((self.f)(borrowed)),
            Err(e) => Err((self, e)),
        }
    }
    /// Applies the operation.
    pub fn apply(self, token: &'a Token) -> U
    where
        Token: TokenTrait<ComparisonError = Infallible>,
    {
        let borrowed = unsafe { self.cell.try_guard(token).unwrap_unchecked() };
        (self.f)(borrowed)
    }
}

impl<
        'a,
        T: ?Sized,
        U,
        F: FnOnce(TokenGuard<'a, T, Token>) -> U,
        Token: TokenTrait<ComparisonMaySpuriouslyEq = False>,
        Cell: TokenCellTrait<T, Token>,
    > TokenMap<'a, T, U, F, Cell, Token, False>
{
    /// Attempt to apply the operation.
    ///
    /// # Errors
    /// If the token comparison failed. Reaching this error is likely to be a fundamental error in your program.
    pub fn try_apply(self, token: &'a Token) -> Result<U, (Self, Token::ComparisonError)> {
        match self.cell.try_guard(token) {
            Ok(borrowed) => Ok((self.f)(borrowed)),
            Err(e) => Err((self, e)),
        }
    }
    /// Applies the operation.
    pub fn apply(self, token: &'a Token) -> U
    where
        Token: TokenTrait<ComparisonError = Infallible>,
    {
        let Ok(borrowed) = self.cell.try_guard(token);
        (self.f)(borrowed)
    }
}

/// An operation waiting to be applied onto a cell by providing a proof of mutable access.
#[must_use = "TokenMaps must be applied to do anything. Note that the closure execution will be deferred to the call-site of `apply/try_apply`"]
pub struct TokenMapMut<
    'a,
    T: ?Sized,
    U,
    F: FnOnce(TokenGuardMut<'a, T, Token>) -> U,
    Cell: ?Sized,
    Token: TokenTrait<ComparisonMaySpuriouslyEq = ComparisonMaySpuriouslyEq> + 'a,
    ComparisonMaySpuriouslyEq,
> {
    pub(crate) cell: &'a Cell,
    pub(crate) f: F,
    pub(crate) marker: core::marker::PhantomData<(&'a T, U, Token, ComparisonMaySpuriouslyEq)>,
}
impl<
        'a,
        T: ?Sized,
        U,
        F: FnOnce(TokenGuardMut<'a, T, Token>) -> U,
        Token: TokenTrait<ComparisonMaySpuriouslyEq = False>,
        Cell: TokenCellTrait<T, Token>,
    > TokenMapMut<'a, T, U, F, Cell, Token, False>
{
    /// Attempt to apply the operation.
    ///
    /// # Errors
    /// If the token comparison failed. Reaching this error is likely to be a fundamental error in your program.
    pub fn try_apply(self, token: &'a mut Token) -> Result<U, Token::ComparisonError> {
        let borrowed = self.cell.try_guard_mut(token)?;
        Ok((self.f)(borrowed))
    }
    /// Applies the operation.
    pub fn apply(self, token: &'a mut Token) -> U
    where
        Token: TokenTrait<ComparisonError = Infallible>,
    {
        let Ok(borrowed) = self.cell.try_guard_mut(token);
        (self.f)(borrowed)
    }
}
impl<
        'a,
        T: ?Sized,
        U,
        F: FnOnce(TokenGuardMut<'a, T, Token>) -> U,
        Token: TokenTrait<ComparisonMaySpuriouslyEq = True>,
        Cell: UnsafeTokenCellTrait<T, Token>,
    > TokenMapMut<'a, T, U, F, Cell, Token, True>
{
    /// Attempt to apply the operation.
    ///
    /// # Errors
    /// If the token comparison failed. Reaching this error is likely to be a fundamental error in your program.
    pub fn try_apply(self, token: &'a mut Token) -> Result<U, Token::ComparisonError> {
        let borrowed = unsafe { self.cell.try_guard_mut(token) }?;
        Ok((self.f)(borrowed))
    }
    /// Applies the operation.
    pub fn apply(self, token: &'a mut Token) -> U
    where
        Token: TokenTrait<ComparisonError = Infallible>,
    {
        let Ok(borrowed) = unsafe { self.cell.try_guard_mut(token) };
        (self.f)(borrowed)
    }
}