enum-ptr 0.2.0

Ergonomic tagged pointer
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

use core::mem::transmute;
use core::ops::Deref;

use crate::{Compact, Compactable};

/// Types that can be borrowed from [`Compact`]. Typically derived from
/// [`EnumPtr`](crate::EnumPtr).
pub trait CompactBorrow: Compactable {
    type Target<'a>
    where
        Self: 'a;

    fn borrow(compact: &Compact<Self>) -> Self::Target<'_>;
}

/// Types that can be used by [`get_ref`](crate::get_ref) and to derive
/// [`CompactBorrow`].
///
/// It's like [`Deref`] but with flexible targets and strict constraints.
///
/// # Safety
///
/// `T` must not `deref` to something that points to its own memory.
///
/// A counter-example is `ManuallyDrop<T>`, which will `deref` to `&T`.
pub unsafe trait FieldDeref {
    type Target<'a>
    where
        Self: 'a;

    fn deref(&self) -> Self::Target<'_>;

    #[doc(hidden)]
    #[inline]
    unsafe fn force_deref<'a>(&self) -> Self::Target<'a> {
        transmute(self.deref())
    }
}

unsafe impl<T> FieldDeref for &T {
    type Target<'a> = &'a T
    where
        Self: 'a;

    #[inline]
    fn deref(&self) -> Self::Target<'_> {
        Deref::deref(self)
    }
}

unsafe impl<T> FieldDeref for &mut T {
    type Target<'a> = &'a T
    where
        Self: 'a;

    #[inline]
    fn deref(&self) -> Self::Target<'_> {
        Deref::deref(self)
    }
}

unsafe impl<T> FieldDeref for Option<&T> {
    type Target<'a> = Option<&'a T>
    where
        Self: 'a;

    #[inline]
    fn deref(&self) -> Self::Target<'_> {
        self.as_deref()
    }
}

unsafe impl<T> FieldDeref for Option<&mut T> {
    type Target<'a> = Option<&'a T>
    where
        Self: 'a;

    #[inline]
    fn deref(&self) -> Self::Target<'_> {
        self.as_deref()
    }
}

#[cfg(feature = "alloc")]
mod alloc_impl {
    use super::*;

    use alloc::boxed::Box;
    use alloc::rc::Rc;
    use alloc::sync::Arc;

    unsafe impl<T> FieldDeref for Box<T> {
        type Target<'a> = &'a T
        where
            Self: 'a;

        #[inline]
        fn deref(&self) -> Self::Target<'_> {
            Deref::deref(self)
        }
    }

    unsafe impl<T> FieldDeref for Rc<T> {
        type Target<'a> = &'a T
        where
            Self: 'a;

        #[inline]
        fn deref(&self) -> Self::Target<'_> {
            Deref::deref(self)
        }
    }

    unsafe impl<T> FieldDeref for Arc<T> {
        type Target<'a> = &'a T
        where
            Self: 'a;

        #[inline]
        fn deref(&self) -> Self::Target<'_> {
            Deref::deref(self)
        }
    }

    unsafe impl<T> FieldDeref for Option<Box<T>> {
        type Target<'a> = Option<&'a T>
        where
            Self: 'a;

        #[inline]
        fn deref(&self) -> Self::Target<'_> {
            self.as_deref()
        }
    }

    unsafe impl<T> FieldDeref for Option<Rc<T>> {
        type Target<'a> = Option<&'a T>
        where
            Self: 'a;

        #[inline]
        fn deref(&self) -> Self::Target<'_> {
            self.as_deref()
        }
    }

    unsafe impl<T> FieldDeref for Option<Arc<T>> {
        type Target<'a> = Option<&'a T>
        where
            Self: 'a;

        #[inline]
        fn deref(&self) -> Self::Target<'_> {
            self.as_deref()
        }
    }
}