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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
use ::core::{
cell::{Cell, UnsafeCell},
mem::{ManuallyDrop, MaybeUninit},
ptr::read,
};
use crate::{Destructure, Ref, Restructure, Value};
// MaybeUninit<T>
// SAFETY:
// - `MaybeUninit<T>` is destructured by value, so its `Destructuring` type is
// `Value`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<T> Destructure for MaybeUninit<T> {
type Underlying = T;
type Destructuring = Value;
fn underlying(&mut self) -> *mut Self::Underlying {
self.as_ptr() as *mut Self::Underlying
}
}
// SAFETY: `restructure` returns a `MaybeUninit<U>` that takes ownership of the
// restructured field because `MaybeUninit<T>` is destructured by value.
unsafe impl<T, U> Restructure<U> for MaybeUninit<T> {
type Restructured = MaybeUninit<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: The caller has guaranteed that `ptr` is a pointer to a
// subfield of some `T`, so it must be properly aligned, valid for
// reads, and initialized. We may move the fields because the
// restructuring type for `MaybeUninit<T>` is `Value`.
unsafe { read(ptr.cast()) }
}
}
// &MaybeUninit<T>
// SAFETY:
// - `&MaybeUninit<T>` is destructured by reference, so its `Destructuring` type
// is `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T> Destructure for &'a MaybeUninit<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
self.as_ptr() as *mut Self::Underlying
}
}
// SAFETY: `restructure` returns a `&MaybeUninit<U>` that borrows the
// restructured field because `&MaybeUninit<T>` is destructured by reference.
unsafe impl<'a, T, U: 'a> Restructure<U> for &'a MaybeUninit<T> {
type Restructured = &'a MaybeUninit<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `MaybeUninit<T>`, so it's safe to dereference. Because the
// restructuring type for `&MaybeUninit<T>` is `Ref`, we may create a
// disjoint borrow and create a reference to it for `'a`.
unsafe { &*ptr.cast() }
}
}
// &mut MaybeUninit<T>
// SAFETY:
// - `&mut MaybeUninit<T>` is destructured by reference, so its `Destructuring`
// type is `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T> Destructure for &'a mut MaybeUninit<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
MaybeUninit::as_mut_ptr(self)
}
}
// SAFETY: `restructure` returns a `&mut MaybeUninit<U>` that borrows the
// restructured field because `&mut MaybeUninit<T>` is destructured by
// reference.
unsafe impl<'a, T, U: 'a> Restructure<U> for &'a mut MaybeUninit<T> {
type Restructured = &'a mut MaybeUninit<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `MaybeUninit<T>`, so it's safe to dereference. Because the
// restructuring type for `&mut MaybeUninit<T>` is `Ref`, we may create
// a disjoint borrow and create a reference to it for `'a`.
unsafe { &mut *ptr.cast() }
}
}
// Cell<T>
// SAFETY:
// - `Cell<T>` is destructured by value, so its `Destructuring` type is `Value`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<T> Destructure for Cell<T> {
type Underlying = T;
type Destructuring = Value;
fn underlying(&mut self) -> *mut Self::Underlying {
self.as_ptr()
}
}
// SAFETY: `restructure` returns a `Cell<U>` that takes ownership of the
// restructured field because `Cell<T>` is destructured by value.
unsafe impl<T, U> Restructure<U> for Cell<T> {
type Restructured = Cell<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
let ptr =
// SAFETY: `Cell<U>` is `repr(transparent)` and so guaranteed to
// have the same representation as the `U` it contains. Therefore,
// the pointer metadata for `*const Cell<U>` is the same as the
// metadata for `*mut U`, and transmuting between the two types is
// sound.
unsafe { ::core::mem::transmute::<*mut U, *const Cell<U>>(ptr) };
// SAFETY: The caller has guaranteed that `ptr` is a pointer to a
// subfield of some `T`, so it must be properly aligned, valid for
// reads, and initialized. We may move the fields because the
// restructuring type for `Cell<T>` is `Value`.
unsafe { read(ptr) }
}
}
// &Cell<T>
// SAFETY:
// - `&Cell<T>` is destructured by reference, so its `Destructuring` type is
// `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T: ?Sized> Destructure for &'a Cell<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
self.as_ptr()
}
}
// SAFETY: `restructure` returns a `&Cell<U>` that borrows the restructured
// field because `&Cell<T>` is destructured by reference.
unsafe impl<'a, T: ?Sized, U: 'a + ?Sized> Restructure<U> for &'a Cell<T> {
type Restructured = &'a Cell<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
let ptr =
// SAFETY: `Cell<U>` is `repr(transparent)` and so guaranteed to
// have the same representation as the `U` it contains. Therefore,
// the pointer metadata for `*const Cell<U>` is the same as the
// metadata for `*mut U`, and transmuting between the two types is
// sound.
unsafe { ::core::mem::transmute::<*mut U, *const Cell<U>>(ptr) };
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `Cell<T>`, so it's safe to dereference. Because the
// restructuring type for `&Cell<T>` is `Ref`, we may create a disjoint
// borrow and create a reference to it for `'a`.
unsafe { &*ptr }
}
}
// &mut Cell<T>
// SAFETY:
// - `&mut Cell<T>` is destructured by reference, so its `Destructuring` type is
// `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T: ?Sized> Destructure for &'a mut Cell<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
self.as_ptr()
}
}
// SAFETY: `restructure` returns a `&mut Cell<U>` that borrows the restructured
// field because `&mut Cell<T>` is destructured by reference.
unsafe impl<'a, T: ?Sized, U: 'a + ?Sized> Restructure<U> for &'a mut Cell<T> {
type Restructured = &'a mut Cell<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
let ptr =
// SAFETY: `Cell<U>` is `repr(transparent)` and so guaranteed to
// have the same representation as the `U` it contains. Therefore,
// the pointer metadata for `*mut Cell<U>` is the same as the
// metadata for `*mut U`, and transmuting between the two types is
// sound.
unsafe { ::core::mem::transmute::<*mut U, *mut Cell<U>>(ptr) };
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `Cell<T>`, so it's safe to dereference. Because the
// restructuring type for `&mut Cell<T>` is `Ref`, we may create a
// disjoint borrow and create a reference to it for `'a`.
unsafe { &mut *ptr }
}
}
// UnsafeCell<T>
// SAFETY:
// - `UnsafeCell<T>` is destructured by value, so its `Destructuring` type is
// `Value`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<T> Destructure for UnsafeCell<T> {
type Underlying = T;
type Destructuring = Value;
fn underlying(&mut self) -> *mut Self::Underlying {
self.get()
}
}
// SAFETY: `restructure` returns a `UnsafeCell<U>` that takes ownership of the
// restructured field because `UnsafeCell<T>` is destructured by value.
unsafe impl<T, U> Restructure<U> for UnsafeCell<T> {
type Restructured = UnsafeCell<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: `UnsafeCell<U>` is `repr(transparent)` and so guaranteed to
// have the same representation as the `U` it contains. Therefore, the
// pointer metadata for `*const UnsafeCell<U>` is the same as the
// metadata for `*mut U`, and transmuting between the two types is
// sound.
let ptr = unsafe {
::core::mem::transmute::<*mut U, *const UnsafeCell<U>>(ptr)
};
// SAFETY: The caller has guaranteed that `ptr` is a pointer to a
// subfield of some `T`, so it must be properly aligned, valid for
// reads, and initialized. We may move the fields because the
// restructuring type for `UnsafeCell<T>` is `Value`.
unsafe { read(ptr) }
}
}
// &mut UnsafeCell<T>
// SAFETY:
// - `&mut UnsafeCell<T>` is destructured by reference, so its `Destructuring`
// type is `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T: ?Sized> Destructure for &'a mut UnsafeCell<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
self.get_mut()
}
}
// SAFETY: `restructure` returns a `&mut UnsafeCell<U>` that borrows the
// restructured field because `&mut UnsafeCell<T>` is destructured by reference.
unsafe impl<'a, T, U> Restructure<U> for &'a mut UnsafeCell<T>
where
T: ?Sized,
U: 'a + ?Sized,
{
type Restructured = &'a mut UnsafeCell<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: `UnsafeCell<U>` is `repr(transparent)` and so guaranteed to
// have the same representation as the `U` it contains. Therefore, the
// pointer metadata for `*mut UnsafeCell<U>` is the same as the metadata
// for `*mut U`, and transmuting between the two types is sound.
let ptr = unsafe {
::core::mem::transmute::<*mut U, *mut UnsafeCell<U>>(ptr)
};
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `UnsafeCell<T>`, so it's safe to dereference. Because the
// restructuring type for `&mut UnsafeCell<T>` is `Ref`, we may create a
// disjoint borrow and create a reference to it for `'a`.
unsafe { &mut *ptr }
}
}
// ManuallyDrop<T>
// SAFETY:
// - `ManuallyDrop<T>` is destructured by value, so its `Destructuring` type is
// `Value`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<T> Destructure for ManuallyDrop<T> {
type Underlying = T;
type Destructuring = Value;
fn underlying(&mut self) -> *mut Self::Underlying {
&mut **self as *mut Self::Underlying
}
}
// SAFETY: `restructure` returns a `ManuallyDrop<U>` that takes ownership of the
// restructured field because `ManuallyDrop<T>` is destructured by value.
unsafe impl<T, U> Restructure<U> for ManuallyDrop<T> {
type Restructured = ManuallyDrop<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: The caller has guaranteed that `ptr` is a pointer to a
// subfield of some `T`, so it must be properly aligned, valid for
// reads, and initialized. We may move the fields because the
// restructuring type for `ManuallyDrop<T>` is `Value`.
unsafe { read(ptr.cast()) }
}
}
// &ManuallyDrop<T>
// SAFETY:
// - `&ManuallyDrop<T>` is destructured by reference, so its `Destructuring`
// type is `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T> Destructure for &'a ManuallyDrop<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
(&***self as *const Self::Underlying).cast_mut()
}
}
// SAFETY: `restructure` returns a `&ManuallyDrop<U>` that borrows the
// restructured field because `&ManuallyDrop<T>` is destructured by reference.
unsafe impl<'a, T, U: 'a> Restructure<U> for &'a ManuallyDrop<T> {
type Restructured = &'a ManuallyDrop<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `ManuallyDrop<T>`, so it's safe to dereference. Because the
// restructuring type for `&ManuallyDrop<T>` is `Ref`, we may create a
// disjoint borrow and create a reference to it for `'a`.
unsafe { &*ptr.cast() }
}
}
// &mut ManuallyDrop<T>
// SAFETY:
// - `&mut ManuallyDrop<T>` is destructured by reference, so its `Destructuring`
// type is `Ref`.
// - `underlying` returns a pointer to its inner type, so it is guaranteed to be
// non-null, properly aligned, and valid for reads.
unsafe impl<'a, T> Destructure for &'a mut ManuallyDrop<T> {
type Underlying = T;
type Destructuring = Ref;
fn underlying(&mut self) -> *mut Self::Underlying {
&mut ***self as *mut Self::Underlying
}
}
// SAFETY: `restructure` returns a `&mut ManuallyDrop<U>` that borrows the
// restructured field because `&mut ManuallyDrop<T>` is destructured by
// reference.
unsafe impl<'a, T, U: 'a> Restructure<U> for &'a mut ManuallyDrop<T> {
type Restructured = &'a mut ManuallyDrop<U>;
unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured {
// SAFETY: The caller has guaranteed that `ptr` points to a subfield of
// some `ManuallyDrop<T>`, so it's safe to dereference. Because the
// restructuring type for `&mut ManuallyDrop<T>` is `Ref`, we may create
// a disjoint borrow and create a reference to it for `'a`.
unsafe { &mut *ptr.cast() }
}
}