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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
use ::core::{
    cmp::*,
    fmt::{self, Debug},
    hash::{self, Hash},
    mem::MaybeUninit as MU,
    ops::{Deref, DerefMut},
};

/// A wrapper to inhibit compiler from automatically calling `T`’s destructor.
/// This wrapper is 0-cost.
///
/// See [`::core::mem::ManuallyDrop`] for more info.
///
/// # Differences with [`::core::mem::ManuallyDrop`]
///
///   - **No niches**
///
///     The current implementation uses [`::core::mem::MaybeUninit`] to make
///     sure the aliasing and `dereferenceable`ity properties of the inner `T`
///     are properly disabled.
///
///     The main side-effect of this implementation is that it disables
///     niches, thereby preventing **discriminant elision**.
///
///     For instance, an <code>[Option]<[ManuallyDrop]<[bool]>></code> will
///     occupy _two_ bytes rather than _one_.
///
///   - It does not implement
///     [`Structural{Partial,}Eq`][::core::marker::StructuralEq].
///
///   - Note that once stdlib's own [`::core::mem::ManuallyDrop`] properly gets
///     its aliasing/`dereferenceable`ity properties removed, this crate shall
///     be updated to just reëxport it (using a `build.rs` to prevent MSRV
///     breakage).
///
///     This means that the _lack of discriminant elision_ cannot be relied upon
///     either!
///
///   - Other than that, this is a `#[repr(transparent)]` wrapper around `T`,
///     thereby having:
///       - equal [`Layout`][::core::alloc::Layout];
///       - equal calling-convention ABI[^1]
///
/// [^1]: this is assuming `MaybeUninit<T>` has the same ABI as `T`, as it
/// currently advertises, despite that probably being a bad idea for
/// a "bag of bytes" `T`-ish wrapper, since it means that padding bytes
/// inside of `T` won't be preserved when working with a
/// `MaybeUninit<T>`. So, if the stdlib were to break the current
/// ABI promise of `MaybeUninit` to cater to that problem, then this crate would
/// probably do so well, unless the `maybe_dangling` changes were to make it to
/// the stdlib first.
#[derive(Copy)]
#[repr(transparent)]
pub struct ManuallyDrop<T> {
    /// Until stdlib guarantees `MaybeDangling` semantics for its `ManuallyDrop`,
    /// we have to polyfill it ourselves using `MaybeUninit`, the only type
    /// known to date to feature such semantics.
    ///
    /// So doing, quite unfortunately, disables niche optimizations.
    ///
    /// # SAFETY INVARIANT: the value must always be init `MU`-wise.
    value: MU<T>,
}

// SAFETY: as per the safety invariant above.
#[allow(unsafe_code)]
impl<T> ManuallyDrop<T> {
    /// Wrap a value to be manually dropped.
    ///
    /// See [`::core::mem::ManuallyDrop::new()`] for more info.
    #[inline]
    pub const fn new(value: T) -> ManuallyDrop<T> {
        Self {
            value: MU::new(value),
        }
    }

    /// Extracts the value from the `ManuallyDrop` container.
    ///
    /// See [`::core::mem::ManuallyDrop::into_inner()`] for more info.
    #[inline]
    pub const fn into_inner(slot: ManuallyDrop<T>) -> T {
        unsafe { MU::assume_init(slot.value) }
    }

    /// Takes the value from the `ManuallyDrop<T>` container out.
    ///
    /// See [`::core::mem::ManuallyDrop::take()`] for more info.
    #[must_use = "if you don't need the value, you can use `ManuallyDrop::drop` instead"]
    #[inline]
    pub unsafe fn take(slot: &mut ManuallyDrop<T>) -> T {
        unsafe {
            slot.value.as_ptr().read()
        }
    }

    /// Manually drops the contained value.
    ///
    /// See [`::core::mem::ManuallyDrop::drop()`] for more info.
    #[inline]
    pub unsafe fn drop(slot: &mut ManuallyDrop<T>) {
        unsafe {
            slot.value.as_mut_ptr().drop_in_place()
        }
    }
}

// Safety: as per the invariant mentioned above.
#[allow(unsafe_code)]
impl<T> DerefMut for ManuallyDrop<T> {
    /// See [`::core::mem::ManuallyDrop::deref_mut()`] for more info.
    #[inline]
    fn deref_mut(&mut self) -> &mut T {
        impl<T> Deref for ManuallyDrop<T> {
            type Target = T;

            #[inline]
            /// See [`::core::mem::ManuallyDrop::deref()`] for more info.
            fn deref(self: &Self) -> &T {
                unsafe {
                    self.value.assume_init_ref()
                }
            }
        }

        unsafe {
            self.value.assume_init_mut()
        }
    }
}

impl<T: Default> Default for ManuallyDrop<T> {
    #[inline]
    fn default() -> Self {
        Self::new(T::default())
    }
}

impl<T: Clone> Clone for ManuallyDrop<T> {
    /// See [`::core::mem::ManuallyDrop::clone()`] for more info.
    fn clone(self: &Self) -> Self {
        Self::new(T::clone(self))
    }

    JustDerefTM! {
        /// See [`::core::mem::ManuallyDrop::clone_from()`] for more info.
        fn clone_from(self: &mut Self, source: &Self);
    }
}

JustDerefTM! {
    impl<T: Debug> Debug for ManuallyDrop<T> {
        /// See [`::core::mem::ManuallyDrop::fmt()`] for more info.
        fn fmt(self: &Self, f: &mut fmt::Formatter<'_>) -> fmt::Result;
    }

    impl<T: Hash> Hash for ManuallyDrop<T> {
        /// See [`::core::mem::ManuallyDrop::hash()`] for more info.
        fn hash<__H: hash::Hasher>(self: &Self, state: &mut __H);
    }

    impl<T: Ord> Ord for ManuallyDrop<T> {
        /// See [`::core::mem::ManuallyDrop::cmp()`] for more info.
        fn cmp(self: &Self, other: &Self) -> Ordering;
    }

    impl<T: PartialOrd> PartialOrd for ManuallyDrop<T> {
        /// See [`::core::mem::ManuallyDrop::partial_cmp()`] for more info.
        fn partial_cmp(self: &Self, other: &Self) -> Option<Ordering>;
    }

    impl<T: PartialEq> PartialEq for ManuallyDrop<T> {
        /// See [`::core::mem::ManuallyDrop::eq()`] for more info.
        fn eq(self: &Self, other: &Self) -> bool;
    }

    impl<T: Eq> Eq for ManuallyDrop<T> {}
}



macro_rules! JustDerefTM {
    (
        $(
            $(#$attr:tt)*
            $($(@$if_unsafe:tt)?
                unsafe
            )?
            impl<T $(: $Bound:path)?>
                $($($Trait:ident)::+ for)?
                ManuallyDrop<T>
            {
                $($inner:tt)*
            }
        )*
    ) => (
        $(
            $(#$attr)*
            $($($if_unsafe)?
                unsafe
            )?
            impl<T $(: $Bound)?>
                $($($Trait)::+ for)?
                ManuallyDrop<T>
            {
                JustDerefTM! {
                    $($inner)*
                }
            }
        )*
        $(
            $(#$attr)*
            $($($if_unsafe)?
                unsafe
            )?
            impl<T $(: $Bound)?>
                $($($Trait)::+ for)?
                crate::MaybeDangling<T>
            {
                JustDerefTM! {
                    $($inner)*
                }
            }
        )*
    );

    (
        $(
            $(#$attr:tt)*
            $pub:vis
            fn $fname:ident
                $(<$H:ident $(: $Bound:path)?>)?
            (
                $(
                    $arg_name:ident : $ArgTy:ty
                ),* $(,)?
            ) $(-> $Ret:ty)? ;
        )*
    ) => (
        $(
            #[inline]
            $(#$attr)*
            #[doc = concat!(
                "\nSee [`::core::mem::ManuallyDrop::", stringify!($fname), "()`] for more info."
            )]
            $pub
            fn $fname
                $(<$H $(: $Bound)?>)?
            (
                $(
                    $arg_name : $ArgTy
                ),*
            ) $(-> $Ret)?
            {
                T::$fname($($arg_name),*)
            }
        )*
    );
}
use JustDerefTM;