library/core/src/ptr/mut_ptr.rs

   1 use super::*;
   2 use crate::cmp::Ordering::{self, Equal, Greater, Less};
   3 use crate::intrinsics;
   4 use crate::slice::{self, SliceIndex};
   5
   6 #[lang = "mut_ptr"]
   7 impl<T: ?Sized> *mut T {
   8     /// Returns `true` if the pointer is null.
   9     ///
  10     /// Note that unsized types have many possible null pointers, as only the
  11     /// raw data pointer is considered, not their length, vtable, etc.
  12     /// Therefore, two pointers that are null may still not compare equal to
  13     /// each other.
  14     ///
  15     /// ## Behavior during const evaluation
  16     ///
  17     /// When this function is used during const evaluation, it may return `false` for pointers
  18     /// that turn out to be null at runtime. Specifically, when a pointer to some memory
  19     /// is offset beyond its bounds in such a way that the resulting pointer is null,
  20     /// the function will still return `false`. There is no way for CTFE to know
  21     /// the absolute position of that memory, so we cannot tell if the pointer is
  22     /// null or not.
  23     ///
  24     /// # Examples
  25     ///
  26     /// Basic usage:
  27     ///
  28     /// ```
  29     /// let mut s = [1, 2, 3];
  30     /// let ptr: *mut u32 = s.as_mut_ptr();
  31     /// assert!(!ptr.is_null());
  32     /// ```
  33     #[stable(feature = "rust1", since = "1.0.0")]
  34     #[rustc_const_unstable(feature = "const_ptr_is_null", issue = "74939")]
  35     #[inline]
  36     pub const fn is_null(self) -> bool {
  37         // Compare via a cast to a thin pointer, so fat pointers are only
  38         // considering their "data" part for null-ness.
  39         (self as *mut u8).guaranteed_eq(null_mut())
  40     }
  41
  42     /// Casts to a pointer of another type.
  43     #[stable(feature = "ptr_cast", since = "1.38.0")]
  44     #[rustc_const_stable(feature = "const_ptr_cast", since = "1.38.0")]
  45     #[inline]
  46     pub const fn cast<U>(self) -> *mut U {
  47         self as _
  48     }
  49
  50     /// Returns `None` if the pointer is null, or else returns a shared reference to
  51     /// the value wrapped in `Some`. If the value may be uninitialized, [`as_uninit_ref`]
  52     /// must be used instead.
  53     ///
  54     /// For the mutable counterpart see [`as_mut`].
  55     ///
  56     /// [`as_uninit_ref`]: #method.as_uninit_ref-1
  57     /// [`as_mut`]: #method.as_mut
  58     ///
  59     /// # Safety
  60     ///
  61     /// When calling this method, you have to ensure that *either* the pointer is NULL *or*
  62     /// all of the following is true:
  63     ///
  64     /// * The pointer must be properly aligned.
  65     ///
  66     /// * It must be "dereferencable" in the sense defined in [the module documentation].
  67     ///
  68     /// * The pointer must point to an initialized instance of `T`.
  69     ///
  70     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
  71     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
  72     ///   In particular, for the duration of this lifetime, the memory the pointer points to must
  73     ///   not get mutated (except inside `UnsafeCell`).
  74     ///
  75     /// This applies even if the result of this method is unused!
  76     /// (The part about being initialized is not yet fully decided, but until
  77     /// it is, the only safe approach is to ensure that they are indeed initialized.)
  78     ///
  79     /// [the module documentation]: crate::ptr#safety
  80     ///
  81     /// # Examples
  82     ///
  83     /// Basic usage:
  84     ///
  85     /// ```
  86     /// let ptr: *mut u8 = &mut 10u8 as *mut u8;
  87     ///
  88     /// unsafe {
  89     ///     if let Some(val_back) = ptr.as_ref() {
  90     ///         println!("We got back the value: {}!", val_back);
  91     ///     }
  92     /// }
  93     /// ```
  94     ///
  95     /// # Null-unchecked version
  96     ///
  97     /// If you are sure the pointer can never be null and are looking for some kind of
  98     /// `as_ref_unchecked` that returns the `&T` instead of `Option<&T>`, know that you can
  99     /// dereference the pointer directly.
 100     ///
 101     /// ```
 102     /// let ptr: *mut u8 = &mut 10u8 as *mut u8;
 103     ///
 104     /// unsafe {
 105     ///     let val_back = &*ptr;
 106     ///     println!("We got back the value: {}!", val_back);
 107     /// }
 108     /// ```
 109     #[stable(feature = "ptr_as_ref", since = "1.9.0")]
 110     #[inline]
 111     pub unsafe fn as_ref<'a>(self) -> Option<&'a T> {
 112         // SAFETY: the caller must guarantee that `self` is valid for a
 113         // reference if it isn't null.
 114         if self.is_null() { None } else { unsafe { Some(&*self) } }
 115     }
 116
 117     /// Returns `None` if the pointer is null, or else returns a shared reference to
 118     /// the value wrapped in `Some`. In contrast to [`as_ref`], this does not require
 119     /// that the value has to be initialized.
 120     ///
 121     /// For the mutable counterpart see [`as_uninit_mut`].
 122     ///
 123     /// [`as_ref`]: #method.as_ref-1
 124     /// [`as_uninit_mut`]: #method.as_uninit_mut
 125     ///
 126     /// # Safety
 127     ///
 128     /// When calling this method, you have to ensure that *either* the pointer is NULL *or*
 129     /// all of the following is true:
 130     ///
 131     /// * The pointer must be properly aligned.
 132     ///
 133     /// * It must be "dereferencable" in the sense defined in [the module documentation].
 134     ///
 135     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
 136     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
 137     ///   In particular, for the duration of this lifetime, the memory the pointer points to must
 138     ///   not get mutated (except inside `UnsafeCell`).
 139     ///
 140     /// This applies even if the result of this method is unused!
 141     ///
 142     /// [the module documentation]: crate::ptr#safety
 143     ///
 144     /// # Examples
 145     ///
 146     /// Basic usage:
 147     ///
 148     /// ```
 149     /// #![feature(ptr_as_uninit)]
 150     ///
 151     /// let ptr: *mut u8 = &mut 10u8 as *mut u8;
 152     ///
 153     /// unsafe {
 154     ///     if let Some(val_back) = ptr.as_uninit_ref() {
 155     ///         println!("We got back the value: {}!", val_back.assume_init());
 156     ///     }
 157     /// }
 158     /// ```
 159     #[inline]
 160     #[unstable(feature = "ptr_as_uninit", issue = "75402")]
 161     pub unsafe fn as_uninit_ref<'a>(self) -> Option<&'a MaybeUninit<T>>
 162     where
 163         T: Sized,
 164     {
 165         // SAFETY: the caller must guarantee that `self` meets all the
 166         // requirements for a reference.
 167         if self.is_null() { None } else { Some(unsafe { &*(self as *const MaybeUninit<T>) }) }
 168     }
 169
 170     /// Calculates the offset from a pointer.
 171     ///
 172     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 173     /// offset of `3 * size_of::<T>()` bytes.
 174     ///
 175     /// # Safety
 176     ///
 177     /// If any of the following conditions are violated, the result is Undefined
 178     /// Behavior:
 179     ///
 180     /// * Both the starting and resulting pointer must be either in bounds or one
 181     ///   byte past the end of the same allocated object. Note that in Rust,
 182     ///   every (stack-allocated) variable is considered a separate allocated object.
 183     ///
 184     /// * The computed offset, **in bytes**, cannot overflow an `isize`.
 185     ///
 186     /// * The offset being in bounds cannot rely on "wrapping around" the address
 187     ///   space. That is, the infinite-precision sum, **in bytes** must fit in a usize.
 188     ///
 189     /// The compiler and standard library generally tries to ensure allocations
 190     /// never reach a size where an offset is a concern. For instance, `Vec`
 191     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 192     /// `vec.as_ptr().add(vec.len())` is always safe.
 193     ///
 194     /// Most platforms fundamentally can't even construct such an allocation.
 195     /// For instance, no known 64-bit platform can ever serve a request
 196     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 197     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 198     /// more than `isize::MAX` bytes with things like Physical Address
 199     /// Extension. As such, memory acquired directly from allocators or memory
 200     /// mapped files *may* be too large to handle with this function.
 201     ///
 202     /// Consider using [`wrapping_offset`] instead if these constraints are
 203     /// difficult to satisfy. The only advantage of this method is that it
 204     /// enables more aggressive compiler optimizations.
 205     ///
 206     /// [`wrapping_offset`]: #method.wrapping_offset
 207     ///
 208     /// # Examples
 209     ///
 210     /// Basic usage:
 211     ///
 212     /// ```
 213     /// let mut s = [1, 2, 3];
 214     /// let ptr: *mut u32 = s.as_mut_ptr();
 215     ///
 216     /// unsafe {
 217     ///     println!("{}", *ptr.offset(1));
 218     ///     println!("{}", *ptr.offset(2));
 219     /// }
 220     /// ```
 221     #[stable(feature = "rust1", since = "1.0.0")]
 222     #[must_use = "returns a new pointer rather than modifying its argument"]
 223     #[rustc_const_unstable(feature = "const_ptr_offset", issue = "71499")]
 224     #[inline]
 225     pub const unsafe fn offset(self, count: isize) -> *mut T
 226     where
 227         T: Sized,
 228     {
 229         // SAFETY: the caller must uphold the safety contract for `offset`.
 230         // The obtained pointer is valid for writes since the caller must
 231         // guarantee that it points to the same allocated object as `self`.
 232         unsafe { intrinsics::offset(self, count) as *mut T }
 233     }
 234
 235     /// Calculates the offset from a pointer using wrapping arithmetic.
 236     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 237     /// offset of `3 * size_of::<T>()` bytes.
 238     ///
 239     /// # Safety
 240     ///
 241     /// The resulting pointer does not need to be in bounds, but it is
 242     /// potentially hazardous to dereference (which requires `unsafe`).
 243     ///
 244     /// In particular, the resulting pointer remains attached to the same allocated
 245     /// object that `self` points to. It may *not* be used to access a
 246     /// different allocated object. Note that in Rust,
 247     /// every (stack-allocated) variable is considered a separate allocated object.
 248     ///
 249     /// In other words, `x.wrapping_offset(y.wrapping_offset_from(x))` is
 250     /// *not* the same as `y`, and dereferencing it is undefined behavior
 251     /// unless `x` and `y` point into the same allocated object.
 252     ///
 253     /// Compared to [`offset`], this method basically delays the requirement of staying
 254     /// within the same allocated object: [`offset`] is immediate Undefined Behavior when
 255     /// crossing object boundaries; `wrapping_offset` produces a pointer but still leads
 256     /// to Undefined Behavior if that pointer is dereferenced. [`offset`] can be optimized
 257     /// better and is thus preferable in performance-sensitive code.
 258     ///
 259     /// If you need to cross object boundaries, cast the pointer to an integer and
 260     /// do the arithmetic there.
 261     ///
 262     /// [`offset`]: #method.offset
 263     ///
 264     /// # Examples
 265     ///
 266     /// Basic usage:
 267     ///
 268     /// ```
 269     /// // Iterate using a raw pointer in increments of two elements
 270     /// let mut data = [1u8, 2, 3, 4, 5];
 271     /// let mut ptr: *mut u8 = data.as_mut_ptr();
 272     /// let step = 2;
 273     /// let end_rounded_up = ptr.wrapping_offset(6);
 274     ///
 275     /// while ptr != end_rounded_up {
 276     ///     unsafe {
 277     ///         *ptr = 0;
 278     ///     }
 279     ///     ptr = ptr.wrapping_offset(step);
 280     /// }
 281     /// assert_eq!(&data, &[0, 2, 0, 4, 0]);
 282     /// ```
 283     #[stable(feature = "ptr_wrapping_offset", since = "1.16.0")]
 284     #[must_use = "returns a new pointer rather than modifying its argument"]
 285     #[rustc_const_unstable(feature = "const_ptr_offset", issue = "71499")]
 286     #[inline]
 287     pub const fn wrapping_offset(self, count: isize) -> *mut T
 288     where
 289         T: Sized,
 290     {
 291         // SAFETY: the `arith_offset` intrinsic has no prerequisites to be called.
 292         unsafe { intrinsics::arith_offset(self, count) as *mut T }
 293     }
 294
 295     /// Returns `None` if the pointer is null, or else returns a unique reference to
 296     /// the value wrapped in `Some`. If the value may be uninitialized, [`as_uninit_mut`]
 297     /// must be used instead.
 298     ///
 299     /// For the shared counterpart see [`as_ref`].
 300     ///
 301     /// [`as_uninit_mut`]: #method.as_uninit_mut
 302     /// [`as_ref`]: #method.as_ref-1
 303     ///
 304     /// # Safety
 305     ///
 306     /// When calling this method, you have to ensure that *either* the pointer is NULL *or*
 307     /// all of the following is true:
 308     ///
 309     /// * The pointer must be properly aligned.
 310     ///
 311     /// * It must be "dereferencable" in the sense defined in [the module documentation].
 312     ///
 313     /// * The pointer must point to an initialized instance of `T`.
 314     ///
 315     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
 316     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
 317     ///   In particular, for the duration of this lifetime, the memory the pointer points to must
 318     ///   not get accessed (read or written) through any other pointer.
 319     ///
 320     /// This applies even if the result of this method is unused!
 321     /// (The part about being initialized is not yet fully decided, but until
 322     /// it is, the only safe approach is to ensure that they are indeed initialized.)
 323     ///
 324     /// [the module documentation]: crate::ptr#safety
 325     ///
 326     /// # Examples
 327     ///
 328     /// Basic usage:
 329     ///
 330     /// ```
 331     /// let mut s = [1, 2, 3];
 332     /// let ptr: *mut u32 = s.as_mut_ptr();
 333     /// let first_value = unsafe { ptr.as_mut().unwrap() };
 334     /// *first_value = 4;
 335     /// # assert_eq!(s, [4, 2, 3]);
 336     /// println!("{:?}", s); // It'll print: "[4, 2, 3]".
 337     /// ```
 338     ///
 339     /// # Null-unchecked version
 340     ///
 341     /// If you are sure the pointer can never be null and are looking for some kind of
 342     /// `as_mut_unchecked` that returns the `&mut T` instead of `Option<&mut T>`, know that
 343     /// you can dereference the pointer directly.
 344     ///
 345     /// ```
 346     /// let mut s = [1, 2, 3];
 347     /// let ptr: *mut u32 = s.as_mut_ptr();
 348     /// let first_value = unsafe { &mut *ptr };
 349     /// *first_value = 4;
 350     /// # assert_eq!(s, [4, 2, 3]);
 351     /// println!("{:?}", s); // It'll print: "[4, 2, 3]".
 352     /// ```
 353     #[stable(feature = "ptr_as_ref", since = "1.9.0")]
 354     #[inline]
 355     pub unsafe fn as_mut<'a>(self) -> Option<&'a mut T> {
 356         // SAFETY: the caller must guarantee that `self` is be valid for
 357         // a mutable reference if it isn't null.
 358         if self.is_null() { None } else { unsafe { Some(&mut *self) } }
 359     }
 360
 361     /// Returns `None` if the pointer is null, or else returns a unique reference to
 362     /// the value wrapped in `Some`. In contrast to [`as_mut`], this does not require
 363     /// that the value has to be initialized.
 364     ///
 365     /// For the shared counterpart see [`as_uninit_ref`].
 366     ///
 367     /// [`as_mut`]: #method.as_mut
 368     /// [`as_uninit_ref`]: #method.as_uninit_ref-1
 369     ///
 370     /// # Safety
 371     ///
 372     /// When calling this method, you have to ensure that *either* the pointer is NULL *or*
 373     /// all of the following is true:
 374     ///
 375     /// * The pointer must be properly aligned.
 376     ///
 377     /// * It must be "dereferencable" in the sense defined in [the module documentation].
 378     ///
 379     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
 380     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
 381     ///   In particular, for the duration of this lifetime, the memory the pointer points to must
 382     ///   not get accessed (read or written) through any other pointer.
 383     ///
 384     /// This applies even if the result of this method is unused!
 385     ///
 386     /// [the module documentation]: crate::ptr#safety
 387     #[inline]
 388     #[unstable(feature = "ptr_as_uninit", issue = "75402")]
 389     pub unsafe fn as_uninit_mut<'a>(self) -> Option<&'a mut MaybeUninit<T>>
 390     where
 391         T: Sized,
 392     {
 393         // SAFETY: the caller must guarantee that `self` meets all the
 394         // requirements for a reference.
 395         if self.is_null() { None } else { Some(unsafe { &mut *(self as *mut MaybeUninit<T>) }) }
 396     }
 397
 398     /// Returns whether two pointers are guaranteed to be equal.
 399     ///
 400     /// At runtime this function behaves like `self == other`.
 401     /// However, in some contexts (e.g., compile-time evaluation),
 402     /// it is not always possible to determine equality of two pointers, so this function may
 403     /// spuriously return `false` for pointers that later actually turn out to be equal.
 404     /// But when it returns `true`, the pointers are guaranteed to be equal.
 405     ///
 406     /// This function is the mirror of [`guaranteed_ne`], but not its inverse. There are pointer
 407     /// comparisons for which both functions return `false`.
 408     ///
 409     /// [`guaranteed_ne`]: #method.guaranteed_ne
 410     ///
 411     /// The return value may change depending on the compiler version and unsafe code may not
 412     /// rely on the result of this function for soundness. It is suggested to only use this function
 413     /// for performance optimizations where spurious `false` return values by this function do not
 414     /// affect the outcome, but just the performance.
 415     /// The consequences of using this method to make runtime and compile-time code behave
 416     /// differently have not been explored. This method should not be used to introduce such
 417     /// differences, and it should also not be stabilized before we have a better understanding
 418     /// of this issue.
 419     #[unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 420     #[rustc_const_unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 421     #[inline]
 422     pub const fn guaranteed_eq(self, other: *mut T) -> bool
 423     where
 424         T: Sized,
 425     {
 426         intrinsics::ptr_guaranteed_eq(self as *const _, other as *const _)
 427     }
 428
 429     /// Returns whether two pointers are guaranteed to be unequal.
 430     ///
 431     /// At runtime this function behaves like `self != other`.
 432     /// However, in some contexts (e.g., compile-time evaluation),
 433     /// it is not always possible to determine the inequality of two pointers, so this function may
 434     /// spuriously return `false` for pointers that later actually turn out to be unequal.
 435     /// But when it returns `true`, the pointers are guaranteed to be unequal.
 436     ///
 437     /// This function is the mirror of [`guaranteed_eq`], but not its inverse. There are pointer
 438     /// comparisons for which both functions return `false`.
 439     ///
 440     /// [`guaranteed_eq`]: #method.guaranteed_eq
 441     ///
 442     /// The return value may change depending on the compiler version and unsafe code may not
 443     /// rely on the result of this function for soundness. It is suggested to only use this function
 444     /// for performance optimizations where spurious `false` return values by this function do not
 445     /// affect the outcome, but just the performance.
 446     /// The consequences of using this method to make runtime and compile-time code behave
 447     /// differently have not been explored. This method should not be used to introduce such
 448     /// differences, and it should also not be stabilized before we have a better understanding
 449     /// of this issue.
 450     #[unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 451     #[rustc_const_unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 452     #[inline]
 453     pub const unsafe fn guaranteed_ne(self, other: *mut T) -> bool
 454     where
 455         T: Sized,
 456     {
 457         intrinsics::ptr_guaranteed_ne(self as *const _, other as *const _)
 458     }
 459
 460     /// Calculates the distance between two pointers. The returned value is in
 461     /// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
 462     ///
 463     /// This function is the inverse of [`offset`].
 464     ///
 465     /// [`offset`]: #method.offset-1
 466     /// [`wrapping_offset_from`]: #method.wrapping_offset_from-1
 467     ///
 468     /// # Safety
 469     ///
 470     /// If any of the following conditions are violated, the result is Undefined
 471     /// Behavior:
 472     ///
 473     /// * Both the starting and other pointer must be either in bounds or one
 474     ///   byte past the end of the same allocated object. Note that in Rust,
 475     ///   every (stack-allocated) variable is considered a separate allocated object.
 476     ///
 477     /// * The distance between the pointers, **in bytes**, cannot overflow an `isize`.
 478     ///
 479     /// * The distance between the pointers, in bytes, must be an exact multiple
 480     ///   of the size of `T`.
 481     ///
 482     /// * The distance being in bounds cannot rely on "wrapping around" the address space.
 483     ///
 484     /// The compiler and standard library generally try to ensure allocations
 485     /// never reach a size where an offset is a concern. For instance, `Vec`
 486     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 487     /// `ptr_into_vec.offset_from(vec.as_ptr())` is always safe.
 488     ///
 489     /// Most platforms fundamentally can't even construct such an allocation.
 490     /// For instance, no known 64-bit platform can ever serve a request
 491     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 492     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 493     /// more than `isize::MAX` bytes with things like Physical Address
 494     /// Extension. As such, memory acquired directly from allocators or memory
 495     /// mapped files *may* be too large to handle with this function.
 496     ///
 497     /// Consider using [`wrapping_offset_from`] instead if these constraints are
 498     /// difficult to satisfy. The only advantage of this method is that it
 499     /// enables more aggressive compiler optimizations.
 500     ///
 501     /// # Panics
 502     ///
 503     /// This function panics if `T` is a Zero-Sized Type ("ZST").
 504     ///
 505     /// # Examples
 506     ///
 507     /// Basic usage:
 508     ///
 509     /// ```
 510     /// #![feature(ptr_offset_from)]
 511     ///
 512     /// let mut a = [0; 5];
 513     /// let ptr1: *mut i32 = &mut a[1];
 514     /// let ptr2: *mut i32 = &mut a[3];
 515     /// unsafe {
 516     ///     assert_eq!(ptr2.offset_from(ptr1), 2);
 517     ///     assert_eq!(ptr1.offset_from(ptr2), -2);
 518     ///     assert_eq!(ptr1.offset(2), ptr2);
 519     ///     assert_eq!(ptr2.offset(-2), ptr1);
 520     /// }
 521     /// ```
 522     #[unstable(feature = "ptr_offset_from", issue = "41079")]
 523     #[rustc_const_unstable(feature = "const_ptr_offset_from", issue = "41079")]
 524     #[inline]
 525     pub const unsafe fn offset_from(self, origin: *const T) -> isize
 526     where
 527         T: Sized,
 528     {
 529         // SAFETY: the caller must uphold the safety contract for `offset_from`.
 530         unsafe { (self as *const T).offset_from(origin) }
 531     }
 532
 533     /// Calculates the distance between two pointers. The returned value is in
 534     /// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
 535     ///
 536     /// If the address different between the two pointers is not a multiple of
 537     /// `mem::size_of::<T>()` then the result of the division is rounded towards
 538     /// zero.
 539     ///
 540     /// Though this method is safe for any two pointers, note that its result
 541     /// will be mostly useless if the two pointers aren't into the same allocated
 542     /// object, for example if they point to two different local variables.
 543     ///
 544     /// # Panics
 545     ///
 546     /// This function panics if `T` is a zero-sized type.
 547     ///
 548     /// # Examples
 549     ///
 550     /// Basic usage:
 551     ///
 552     /// ```
 553     /// #![feature(ptr_wrapping_offset_from)]
 554     ///
 555     /// let mut a = [0; 5];
 556     /// let ptr1: *mut i32 = &mut a[1];
 557     /// let ptr2: *mut i32 = &mut a[3];
 558     /// assert_eq!(ptr2.wrapping_offset_from(ptr1), 2);
 559     /// assert_eq!(ptr1.wrapping_offset_from(ptr2), -2);
 560     /// assert_eq!(ptr1.wrapping_offset(2), ptr2);
 561     /// assert_eq!(ptr2.wrapping_offset(-2), ptr1);
 562     ///
 563     /// let ptr1: *mut i32 = 3 as _;
 564     /// let ptr2: *mut i32 = 13 as _;
 565     /// assert_eq!(ptr2.wrapping_offset_from(ptr1), 2);
 566     /// ```
 567     #[unstable(feature = "ptr_wrapping_offset_from", issue = "41079")]
 568     #[rustc_deprecated(
 569         since = "1.46.0",
 570         reason = "Pointer distances across allocation \
 571         boundaries are not typically meaningful. \
 572         Use integer subtraction if you really need this."
 573     )]
 574     #[inline]
 575     pub fn wrapping_offset_from(self, origin: *const T) -> isize
 576     where
 577         T: Sized,
 578     {
 579         #[allow(deprecated_in_future, deprecated)]
 580         (self as *const T).wrapping_offset_from(origin)
 581     }
 582
 583     /// Calculates the offset from a pointer (convenience for `.offset(count as isize)`).
 584     ///
 585     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 586     /// offset of `3 * size_of::<T>()` bytes.
 587     ///
 588     /// # Safety
 589     ///
 590     /// If any of the following conditions are violated, the result is Undefined
 591     /// Behavior:
 592     ///
 593     /// * Both the starting and resulting pointer must be either in bounds or one
 594     ///   byte past the end of the same allocated object. Note that in Rust,
 595     ///   every (stack-allocated) variable is considered a separate allocated object.
 596     ///
 597     /// * The computed offset, **in bytes**, cannot overflow an `isize`.
 598     ///
 599     /// * The offset being in bounds cannot rely on "wrapping around" the address
 600     ///   space. That is, the infinite-precision sum must fit in a `usize`.
 601     ///
 602     /// The compiler and standard library generally tries to ensure allocations
 603     /// never reach a size where an offset is a concern. For instance, `Vec`
 604     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 605     /// `vec.as_ptr().add(vec.len())` is always safe.
 606     ///
 607     /// Most platforms fundamentally can't even construct such an allocation.
 608     /// For instance, no known 64-bit platform can ever serve a request
 609     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 610     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 611     /// more than `isize::MAX` bytes with things like Physical Address
 612     /// Extension. As such, memory acquired directly from allocators or memory
 613     /// mapped files *may* be too large to handle with this function.
 614     ///
 615     /// Consider using [`wrapping_add`] instead if these constraints are
 616     /// difficult to satisfy. The only advantage of this method is that it
 617     /// enables more aggressive compiler optimizations.
 618     ///
 619     /// [`wrapping_add`]: #method.wrapping_add
 620     ///
 621     /// # Examples
 622     ///
 623     /// Basic usage:
 624     ///
 625     /// ```
 626     /// let s: &str = "123";
 627     /// let ptr: *const u8 = s.as_ptr();
 628     ///
 629     /// unsafe {
 630     ///     println!("{}", *ptr.add(1) as char);
 631     ///     println!("{}", *ptr.add(2) as char);
 632     /// }
 633     /// ```
 634     #[stable(feature = "pointer_methods", since = "1.26.0")]
 635     #[must_use = "returns a new pointer rather than modifying its argument"]
 636     #[rustc_const_unstable(feature = "const_ptr_offset", issue = "71499")]
 637     #[inline]
 638     pub const unsafe fn add(self, count: usize) -> Self
 639     where
 640         T: Sized,
 641     {
 642         // SAFETY: the caller must uphold the safety contract for `offset`.
 643         unsafe { self.offset(count as isize) }
 644     }
 645
 646     /// Calculates the offset from a pointer (convenience for
 647     /// `.offset((count as isize).wrapping_neg())`).
 648     ///
 649     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 650     /// offset of `3 * size_of::<T>()` bytes.
 651     ///
 652     /// # Safety
 653     ///
 654     /// If any of the following conditions are violated, the result is Undefined
 655     /// Behavior:
 656     ///
 657     /// * Both the starting and resulting pointer must be either in bounds or one
 658     ///   byte past the end of the same allocated object. Note that in Rust,
 659     ///   every (stack-allocated) variable is considered a separate allocated object.
 660     ///
 661     /// * The computed offset cannot exceed `isize::MAX` **bytes**.
 662     ///
 663     /// * The offset being in bounds cannot rely on "wrapping around" the address
 664     ///   space. That is, the infinite-precision sum must fit in a usize.
 665     ///
 666     /// The compiler and standard library generally tries to ensure allocations
 667     /// never reach a size where an offset is a concern. For instance, `Vec`
 668     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 669     /// `vec.as_ptr().add(vec.len()).sub(vec.len())` is always safe.
 670     ///
 671     /// Most platforms fundamentally can't even construct such an allocation.
 672     /// For instance, no known 64-bit platform can ever serve a request
 673     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 674     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 675     /// more than `isize::MAX` bytes with things like Physical Address
 676     /// Extension. As such, memory acquired directly from allocators or memory
 677     /// mapped files *may* be too large to handle with this function.
 678     ///
 679     /// Consider using [`wrapping_sub`] instead if these constraints are
 680     /// difficult to satisfy. The only advantage of this method is that it
 681     /// enables more aggressive compiler optimizations.
 682     ///
 683     /// [`wrapping_sub`]: #method.wrapping_sub
 684     ///
 685     /// # Examples
 686     ///
 687     /// Basic usage:
 688     ///
 689     /// ```
 690     /// let s: &str = "123";
 691     ///
 692     /// unsafe {
 693     ///     let end: *const u8 = s.as_ptr().add(3);
 694     ///     println!("{}", *end.sub(1) as char);
 695     ///     println!("{}", *end.sub(2) as char);
 696     /// }
 697     /// ```
 698     #[stable(feature = "pointer_methods", since = "1.26.0")]
 699     #[must_use = "returns a new pointer rather than modifying its argument"]
 700     #[rustc_const_unstable(feature = "const_ptr_offset", issue = "71499")]
 701     #[inline]
 702     pub const unsafe fn sub(self, count: usize) -> Self
 703     where
 704         T: Sized,
 705     {
 706         // SAFETY: the caller must uphold the safety contract for `offset`.
 707         unsafe { self.offset((count as isize).wrapping_neg()) }
 708     }
 709
 710     /// Calculates the offset from a pointer using wrapping arithmetic.
 711     /// (convenience for `.wrapping_offset(count as isize)`)
 712     ///
 713     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 714     /// offset of `3 * size_of::<T>()` bytes.
 715     ///
 716     /// # Safety
 717     ///
 718     /// The resulting pointer does not need to be in bounds, but it is
 719     /// potentially hazardous to dereference (which requires `unsafe`).
 720     ///
 721     /// In particular, the resulting pointer remains attached to the same allocated
 722     /// object that `self` points to. It may *not* be used to access a
 723     /// different allocated object. Note that in Rust,
 724     /// every (stack-allocated) variable is considered a separate allocated object.
 725     ///
 726     /// Compared to [`add`], this method basically delays the requirement of staying
 727     /// within the same allocated object: [`add`] is immediate Undefined Behavior when
 728     /// crossing object boundaries; `wrapping_add` produces a pointer but still leads
 729     /// to Undefined Behavior if that pointer is dereferenced. [`add`] can be optimized
 730     /// better and is thus preferable in performance-sensitive code.
 731     ///
 732     /// If you need to cross object boundaries, cast the pointer to an integer and
 733     /// do the arithmetic there.
 734     ///
 735     /// [`add`]: #method.add
 736     ///
 737     /// # Examples
 738     ///
 739     /// Basic usage:
 740     ///
 741     /// ```
 742     /// // Iterate using a raw pointer in increments of two elements
 743     /// let data = [1u8, 2, 3, 4, 5];
 744     /// let mut ptr: *const u8 = data.as_ptr();
 745     /// let step = 2;
 746     /// let end_rounded_up = ptr.wrapping_add(6);
 747     ///
 748     /// // This loop prints "1, 3, 5, "
 749     /// while ptr != end_rounded_up {
 750     ///     unsafe {
 751     ///         print!("{}, ", *ptr);
 752     ///     }
 753     ///     ptr = ptr.wrapping_add(step);
 754     /// }
 755     /// ```
 756     #[stable(feature = "pointer_methods", since = "1.26.0")]
 757     #[must_use = "returns a new pointer rather than modifying its argument"]
 758     #[rustc_const_unstable(feature = "const_ptr_offset", issue = "71499")]
 759     #[inline]
 760     pub const fn wrapping_add(self, count: usize) -> Self
 761     where
 762         T: Sized,
 763     {
 764         self.wrapping_offset(count as isize)
 765     }
 766
 767     /// Calculates the offset from a pointer using wrapping arithmetic.
 768     /// (convenience for `.wrapping_offset((count as isize).wrapping_sub())`)
 769     ///
 770     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 771     /// offset of `3 * size_of::<T>()` bytes.
 772     ///
 773     /// # Safety
 774     ///
 775     /// The resulting pointer does not need to be in bounds, but it is
 776     /// potentially hazardous to dereference (which requires `unsafe`).
 777     ///
 778     /// In particular, the resulting pointer remains attached to the same allocated
 779     /// object that `self` points to. It may *not* be used to access a
 780     /// different allocated object. Note that in Rust,
 781     /// every (stack-allocated) variable is considered a separate allocated object.
 782     ///
 783     /// Compared to [`sub`], this method basically delays the requirement of staying
 784     /// within the same allocated object: [`sub`] is immediate Undefined Behavior when
 785     /// crossing object boundaries; `wrapping_sub` produces a pointer but still leads
 786     /// to Undefined Behavior if that pointer is dereferenced. [`sub`] can be optimized
 787     /// better and is thus preferable in performance-sensitive code.
 788     ///
 789     /// If you need to cross object boundaries, cast the pointer to an integer and
 790     /// do the arithmetic there.
 791     ///
 792     /// [`sub`]: #method.sub
 793     ///
 794     /// # Examples
 795     ///
 796     /// Basic usage:
 797     ///
 798     /// ```
 799     /// // Iterate using a raw pointer in increments of two elements (backwards)
 800     /// let data = [1u8, 2, 3, 4, 5];
 801     /// let mut ptr: *const u8 = data.as_ptr();
 802     /// let start_rounded_down = ptr.wrapping_sub(2);
 803     /// ptr = ptr.wrapping_add(4);
 804     /// let step = 2;
 805     /// // This loop prints "5, 3, 1, "
 806     /// while ptr != start_rounded_down {
 807     ///     unsafe {
 808     ///         print!("{}, ", *ptr);
 809     ///     }
 810     ///     ptr = ptr.wrapping_sub(step);
 811     /// }
 812     /// ```
 813     #[stable(feature = "pointer_methods", since = "1.26.0")]
 814     #[must_use = "returns a new pointer rather than modifying its argument"]
 815     #[rustc_const_unstable(feature = "const_ptr_offset", issue = "71499")]
 816     #[inline]
 817     pub const fn wrapping_sub(self, count: usize) -> Self
 818     where
 819         T: Sized,
 820     {
 821         self.wrapping_offset((count as isize).wrapping_neg())
 822     }
 823
 824     /// Sets the pointer value to `ptr`.
 825     ///
 826     /// In case `self` is a (fat) pointer to an unsized type, this operation
 827     /// will only affect the pointer part, whereas for (thin) pointers to
 828     /// sized types, this has the same effect as a simple assignment.
 829     ///
 830     /// The resulting pointer will have provenance of `val`, i.e., for a fat
 831     /// pointer, this operation is semantically the same as creating a new
 832     /// fat pointer with the data pointer value of `val` but the metadata of
 833     /// `self`.
 834     ///
 835     /// # Examples
 836     ///
 837     /// This function is primarily useful for allowing byte-wise pointer
 838     /// arithmetic on potentially fat pointers:
 839     ///
 840     /// ```
 841     /// #![feature(set_ptr_value)]
 842     /// # use core::fmt::Debug;
 843     /// let mut arr: [i32; 3] = [1, 2, 3];
 844     /// let mut ptr = &mut arr[0] as *mut dyn Debug;
 845     /// let thin = ptr as *mut u8;
 846     /// unsafe {
 847     ///     ptr = ptr.set_ptr_value(thin.add(8));
 848     ///     # assert_eq!(*(ptr as *mut i32), 3);
 849     ///     println!("{:?}", &*ptr); // will print "3"
 850     /// }
 851     /// ```
 852     #[unstable(feature = "set_ptr_value", issue = "75091")]
 853     #[must_use = "returns a new pointer rather than modifying its argument"]
 854     #[inline]
 855     pub fn set_ptr_value(mut self, val: *mut u8) -> Self {
 856         let thin = &mut self as *mut *mut T as *mut *mut u8;
 857         // SAFETY: In case of a thin pointer, this operations is identical
 858         // to a simple assignment. In case of a fat pointer, with the current
 859         // fat pointer layout implementation, the first field of such a
 860         // pointer is always the data pointer, which is likewise assigned.
 861         unsafe { *thin = val };
 862         self
 863     }
 864
 865     /// Reads the value from `self` without moving it. This leaves the
 866     /// memory in `self` unchanged.
 867     ///
 868     /// See [`ptr::read`] for safety concerns and examples.
 869     ///
 870     /// [`ptr::read`]: ./ptr/fn.read.html
 871     #[stable(feature = "pointer_methods", since = "1.26.0")]
 872     #[inline]
 873     pub unsafe fn read(self) -> T
 874     where
 875         T: Sized,
 876     {
 877         // SAFETY: the caller must uphold the safety contract for ``.
 878         unsafe { read(self) }
 879     }
 880
 881     /// Performs a volatile read of the value from `self` without moving it. This
 882     /// leaves the memory in `self` unchanged.
 883     ///
 884     /// Volatile operations are intended to act on I/O memory, and are guaranteed
 885     /// to not be elided or reordered by the compiler across other volatile
 886     /// operations.
 887     ///
 888     /// See [`ptr::read_volatile`] for safety concerns and examples.
 889     ///
 890     /// [`ptr::read_volatile`]: ./ptr/fn.read_volatile.html
 891     #[stable(feature = "pointer_methods", since = "1.26.0")]
 892     #[inline]
 893     pub unsafe fn read_volatile(self) -> T
 894     where
 895         T: Sized,
 896     {
 897         // SAFETY: the caller must uphold the safety contract for `read_volatile`.
 898         unsafe { read_volatile(self) }
 899     }
 900
 901     /// Reads the value from `self` without moving it. This leaves the
 902     /// memory in `self` unchanged.
 903     ///
 904     /// Unlike `read`, the pointer may be unaligned.
 905     ///
 906     /// See [`ptr::read_unaligned`] for safety concerns and examples.
 907     ///
 908     /// [`ptr::read_unaligned`]: ./ptr/fn.read_unaligned.html
 909     #[stable(feature = "pointer_methods", since = "1.26.0")]
 910     #[inline]
 911     pub unsafe fn read_unaligned(self) -> T
 912     where
 913         T: Sized,
 914     {
 915         // SAFETY: the caller must uphold the safety contract for `read_unaligned`.
 916         unsafe { read_unaligned(self) }
 917     }
 918
 919     /// Copies `count * size_of<T>` bytes from `self` to `dest`. The source
 920     /// and destination may overlap.
 921     ///
 922     /// NOTE: this has the *same* argument order as [`ptr::copy`].
 923     ///
 924     /// See [`ptr::copy`] for safety concerns and examples.
 925     ///
 926     /// [`ptr::copy`]: ./ptr/fn.copy.html
 927     #[stable(feature = "pointer_methods", since = "1.26.0")]
 928     #[inline]
 929     pub unsafe fn copy_to(self, dest: *mut T, count: usize)
 930     where
 931         T: Sized,
 932     {
 933         // SAFETY: the caller must uphold the safety contract for `copy`.
 934         unsafe { copy(self, dest, count) }
 935     }
 936
 937     /// Copies `count * size_of<T>` bytes from `self` to `dest`. The source
 938     /// and destination may *not* overlap.
 939     ///
 940     /// NOTE: this has the *same* argument order as [`ptr::copy_nonoverlapping`].
 941     ///
 942     /// See [`ptr::copy_nonoverlapping`] for safety concerns and examples.
 943     ///
 944     /// [`ptr::copy_nonoverlapping`]: ./ptr/fn.copy_nonoverlapping.html
 945     #[stable(feature = "pointer_methods", since = "1.26.0")]
 946     #[inline]
 947     pub unsafe fn copy_to_nonoverlapping(self, dest: *mut T, count: usize)
 948     where
 949         T: Sized,
 950     {
 951         // SAFETY: the caller must uphold the safety contract for `copy_nonoverlapping`.
 952         unsafe { copy_nonoverlapping(self, dest, count) }
 953     }
 954
 955     /// Copies `count * size_of<T>` bytes from `src` to `self`. The source
 956     /// and destination may overlap.
 957     ///
 958     /// NOTE: this has the *opposite* argument order of [`ptr::copy`].
 959     ///
 960     /// See [`ptr::copy`] for safety concerns and examples.
 961     ///
 962     /// [`ptr::copy`]: ./ptr/fn.copy.html
 963     #[stable(feature = "pointer_methods", since = "1.26.0")]
 964     #[inline]
 965     pub unsafe fn copy_from(self, src: *const T, count: usize)
 966     where
 967         T: Sized,
 968     {
 969         // SAFETY: the caller must uphold the safety contract for `copy`.
 970         unsafe { copy(src, self, count) }
 971     }
 972
 973     /// Copies `count * size_of<T>` bytes from `src` to `self`. The source
 974     /// and destination may *not* overlap.
 975     ///
 976     /// NOTE: this has the *opposite* argument order of [`ptr::copy_nonoverlapping`].
 977     ///
 978     /// See [`ptr::copy_nonoverlapping`] for safety concerns and examples.
 979     ///
 980     /// [`ptr::copy_nonoverlapping`]: ./ptr/fn.copy_nonoverlapping.html
 981     #[stable(feature = "pointer_methods", since = "1.26.0")]
 982     #[inline]
 983     pub unsafe fn copy_from_nonoverlapping(self, src: *const T, count: usize)
 984     where
 985         T: Sized,
 986     {
 987         // SAFETY: the caller must uphold the safety contract for `copy_nonoverlapping`.
 988         unsafe { copy_nonoverlapping(src, self, count) }
 989     }
 990
 991     /// Executes the destructor (if any) of the pointed-to value.
 992     ///
 993     /// See [`ptr::drop_in_place`] for safety concerns and examples.
 994     ///
 995     /// [`ptr::drop_in_place`]: ./ptr/fn.drop_in_place.html
 996     #[stable(feature = "pointer_methods", since = "1.26.0")]
 997     #[inline]
 998     pub unsafe fn drop_in_place(self) {
 999         // SAFETY: the caller must uphold the safety contract for `drop_in_place`.
1000         unsafe { drop_in_place(self) }
1001     }
1002
1003     /// Overwrites a memory location with the given value without reading or
1004     /// dropping the old value.
1005     ///
1006     /// See [`ptr::write`] for safety concerns and examples.
1007     ///
1008     /// [`ptr::write`]: ./ptr/fn.write.html
1009     #[stable(feature = "pointer_methods", since = "1.26.0")]
1010     #[inline]
1011     pub unsafe fn write(self, val: T)
1012     where
1013         T: Sized,
1014     {
1015         // SAFETY: the caller must uphold the safety contract for `write`.
1016         unsafe { write(self, val) }
1017     }
1018
1019     /// Invokes memset on the specified pointer, setting `count * size_of::<T>()`
1020     /// bytes of memory starting at `self` to `val`.
1021     ///
1022     /// See [`ptr::write_bytes`] for safety concerns and examples.
1023     ///
1024     /// [`ptr::write_bytes`]: ./ptr/fn.write_bytes.html
1025     #[stable(feature = "pointer_methods", since = "1.26.0")]
1026     #[inline]
1027     pub unsafe fn write_bytes(self, val: u8, count: usize)
1028     where
1029         T: Sized,
1030     {
1031         // SAFETY: the caller must uphold the safety contract for `write_bytes`.
1032         unsafe { write_bytes(self, val, count) }
1033     }
1034
1035     /// Performs a volatile write of a memory location with the given value without
1036     /// reading or dropping the old value.
1037     ///
1038     /// Volatile operations are intended to act on I/O memory, and are guaranteed
1039     /// to not be elided or reordered by the compiler across other volatile
1040     /// operations.
1041     ///
1042     /// See [`ptr::write_volatile`] for safety concerns and examples.
1043     ///
1044     /// [`ptr::write_volatile`]: ./ptr/fn.write_volatile.html
1045     #[stable(feature = "pointer_methods", since = "1.26.0")]
1046     #[inline]
1047     pub unsafe fn write_volatile(self, val: T)
1048     where
1049         T: Sized,
1050     {
1051         // SAFETY: the caller must uphold the safety contract for `write_volatile`.
1052         unsafe { write_volatile(self, val) }
1053     }
1054
1055     /// Overwrites a memory location with the given value without reading or
1056     /// dropping the old value.
1057     ///
1058     /// Unlike `write`, the pointer may be unaligned.
1059     ///
1060     /// See [`ptr::write_unaligned`] for safety concerns and examples.
1061     ///
1062     /// [`ptr::write_unaligned`]: ./ptr/fn.write_unaligned.html
1063     #[stable(feature = "pointer_methods", since = "1.26.0")]
1064     #[inline]
1065     pub unsafe fn write_unaligned(self, val: T)
1066     where
1067         T: Sized,
1068     {
1069         // SAFETY: the caller must uphold the safety contract for `write_unaligned`.
1070         unsafe { write_unaligned(self, val) }
1071     }
1072
1073     /// Replaces the value at `self` with `src`, returning the old
1074     /// value, without dropping either.
1075     ///
1076     /// See [`ptr::replace`] for safety concerns and examples.
1077     ///
1078     /// [`ptr::replace`]: ./ptr/fn.replace.html
1079     #[stable(feature = "pointer_methods", since = "1.26.0")]
1080     #[inline]
1081     pub unsafe fn replace(self, src: T) -> T
1082     where
1083         T: Sized,
1084     {
1085         // SAFETY: the caller must uphold the safety contract for `replace`.
1086         unsafe { replace(self, src) }
1087     }
1088
1089     /// Swaps the values at two mutable locations of the same type, without
1090     /// deinitializing either. They may overlap, unlike `mem::swap` which is
1091     /// otherwise equivalent.
1092     ///
1093     /// See [`ptr::swap`] for safety concerns and examples.
1094     ///
1095     /// [`ptr::swap`]: ./ptr/fn.swap.html
1096     #[stable(feature = "pointer_methods", since = "1.26.0")]
1097     #[inline]
1098     pub unsafe fn swap(self, with: *mut T)
1099     where
1100         T: Sized,
1101     {
1102         // SAFETY: the caller must uphold the safety contract for `swap`.
1103         unsafe { swap(self, with) }
1104     }
1105
1106     /// Computes the offset that needs to be applied to the pointer in order to make it aligned to
1107     /// `align`.
1108     ///
1109     /// If it is not possible to align the pointer, the implementation returns
1110     /// `usize::MAX`. It is permissible for the implementation to *always*
1111     /// return `usize::MAX`. Only your algorithm's performance can depend
1112     /// on getting a usable offset here, not its correctness.
1113     ///
1114     /// The offset is expressed in number of `T` elements, and not bytes. The value returned can be
1115     /// used with the `wrapping_add` method.
1116     ///
1117     /// There are no guarantees whatsoever that offsetting the pointer will not overflow or go
1118     /// beyond the allocation that the pointer points into. It is up to the caller to ensure that
1119     /// the returned offset is correct in all terms other than alignment.
1120     ///
1121     /// # Panics
1122     ///
1123     /// The function panics if `align` is not a power-of-two.
1124     ///
1125     /// # Examples
1126     ///
1127     /// Accessing adjacent `u8` as `u16`
1128     ///
1129     /// ```
1130     /// # fn foo(n: usize) {
1131     /// # use std::mem::align_of;
1132     /// # unsafe {
1133     /// let x = [5u8, 6u8, 7u8, 8u8, 9u8];
1134     /// let ptr = &x[n] as *const u8;
1135     /// let offset = ptr.align_offset(align_of::<u16>());
1136     /// if offset < x.len() - n - 1 {
1137     ///     let u16_ptr = ptr.add(offset) as *const u16;
1138     ///     assert_ne!(*u16_ptr, 500);
1139     /// } else {
1140     ///     // while the pointer can be aligned via `offset`, it would point
1141     ///     // outside the allocation
1142     /// }
1143     /// # } }
1144     /// ```
1145     #[stable(feature = "align_offset", since = "1.36.0")]
1146     pub fn align_offset(self, align: usize) -> usize
1147     where
1148         T: Sized,
1149     {
1150         if !align.is_power_of_two() {
1151             panic!("align_offset: align is not a power-of-two");
1152         }
1153         // SAFETY: `align` has been checked to be a power of 2 above
1154         unsafe { align_offset(self, align) }
1155     }
1156 }
1157
1158 #[lang = "mut_slice_ptr"]
1159 impl<T> *mut [T] {
1160     /// Returns the length of a raw slice.
1161     ///
1162     /// The returned value is the number of **elements**, not the number of bytes.
1163     ///
1164     /// This function is safe, even when the raw slice cannot be cast to a slice
1165     /// reference because the pointer is null or unaligned.
1166     ///
1167     /// # Examples
1168     ///
1169     /// ```rust
1170     /// #![feature(slice_ptr_len)]
1171     /// use std::ptr;
1172     ///
1173     /// let slice: *mut [i8] = ptr::slice_from_raw_parts_mut(ptr::null_mut(), 3);
1174     /// assert_eq!(slice.len(), 3);
1175     /// ```
1176     #[inline]
1177     #[unstable(feature = "slice_ptr_len", issue = "71146")]
1178     #[rustc_const_unstable(feature = "const_slice_ptr_len", issue = "71146")]
1179     pub const fn len(self) -> usize {
1180         // SAFETY: this is safe because `*const [T]` and `FatPtr<T>` have the same layout.
1181         // Only `std` can make this guarantee.
1182         unsafe { Repr { rust_mut: self }.raw }.len
1183     }
1184
1185     /// Returns a raw pointer to the slice's buffer.
1186     ///
1187     /// This is equivalent to casting `self` to `*mut T`, but more type-safe.
1188     ///
1189     /// # Examples
1190     ///
1191     /// ```rust
1192     /// #![feature(slice_ptr_get)]
1193     /// use std::ptr;
1194     ///
1195     /// let slice: *mut [i8] = ptr::slice_from_raw_parts_mut(ptr::null_mut(), 3);
1196     /// assert_eq!(slice.as_mut_ptr(), 0 as *mut i8);
1197     /// ```
1198     #[inline]
1199     #[unstable(feature = "slice_ptr_get", issue = "74265")]
1200     #[rustc_const_unstable(feature = "slice_ptr_get", issue = "74265")]
1201     pub const fn as_mut_ptr(self) -> *mut T {
1202         self as *mut T
1203     }
1204
1205     /// Returns a raw pointer to an element or subslice, without doing bounds
1206     /// checking.
1207     ///
1208     /// Calling this method with an out-of-bounds index or when `self` is not dereferencable
1209     /// is *[undefined behavior]* even if the resulting pointer is not used.
1210     ///
1211     /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1212     ///
1213     /// # Examples
1214     ///
1215     /// ```
1216     /// #![feature(slice_ptr_get)]
1217     ///
1218     /// let x = &mut [1, 2, 4] as *mut [i32];
1219     ///
1220     /// unsafe {
1221     ///     assert_eq!(x.get_unchecked_mut(1), x.as_mut_ptr().add(1));
1222     /// }
1223     /// ```
1224     #[unstable(feature = "slice_ptr_get", issue = "74265")]
1225     #[inline]
1226     pub unsafe fn get_unchecked_mut<I>(self, index: I) -> *mut I::Output
1227     where
1228         I: SliceIndex<[T]>,
1229     {
1230         // SAFETY: the caller ensures that `self` is dereferencable and `index` in-bounds.
1231         unsafe { index.get_unchecked_mut(self) }
1232     }
1233
1234     /// Returns `None` if the pointer is null, or else returns a shared slice to
1235     /// the value wrapped in `Some`. In contrast to [`as_ref`], this does not require
1236     /// that the value has to be initialized.
1237     ///
1238     /// For the mutable counterpart see [`as_uninit_slice_mut`].
1239     ///
1240     /// [`as_ref`]: #method.as_ref-1
1241     /// [`as_uninit_slice_mut`]: #method.as_uninit_slice_mut
1242     ///
1243     /// # Safety
1244     ///
1245     /// When calling this method, you have to ensure that *either* the pointer is NULL *or*
1246     /// all of the following is true:
1247     ///
1248     /// * The pointer must be [valid] for reads for `ptr.len() * mem::size_of::<T>()` many bytes,
1249     ///   and it must be properly aligned. This means in particular:
1250     ///
1251     ///     * The entire memory range of this slice must be contained within a single allocated object!
1252     ///       Slices can never span across multiple allocated objects.
1253     ///
1254     ///     * The pointer must be aligned even for zero-length slices. One
1255     ///       reason for this is that enum layout optimizations may rely on references
1256     ///       (including slices of any length) being aligned and non-null to distinguish
1257     ///       them from other data. You can obtain a pointer that is usable as `data`
1258     ///       for zero-length slices using [`NonNull::dangling()`].
1259     ///
1260     /// * The total size `ptr.len() * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
1261     ///   See the safety documentation of [`pointer::offset`].
1262     ///
1263     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
1264     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
1265     ///   In particular, for the duration of this lifetime, the memory the pointer points to must
1266     ///   not get mutated (except inside `UnsafeCell`).
1267     ///
1268     /// This applies even if the result of this method is unused!
1269     ///
1270     /// See also [`slice::from_raw_parts`][].
1271     ///
1272     /// [valid]: crate::ptr#safety
1273     /// [`NonNull::dangling()`]: NonNull::dangling
1274     /// [`pointer::offset`]: ../std/primitive.pointer.html#method.offset
1275     #[inline]
1276     #[unstable(feature = "ptr_as_uninit", issue = "75402")]
1277     pub unsafe fn as_uninit_slice<'a>(self) -> Option<&'a [MaybeUninit<T>]> {
1278         if self.is_null() {
1279             None
1280         } else {
1281             // SAFETY: the caller must uphold the safety contract for `as_uninit_slice`.
1282             Some(unsafe { slice::from_raw_parts(self as *const MaybeUninit<T>, self.len()) })
1283         }
1284     }
1285
1286     /// Returns `None` if the pointer is null, or else returns a unique slice to
1287     /// the value wrapped in `Some`. In contrast to [`as_mut`], this does not require
1288     /// that the value has to be initialized.
1289     ///
1290     /// For the shared counterpart see [`as_uninit_slice`].
1291     ///
1292     /// [`as_mut`]: #method.as_mut
1293     /// [`as_uninit_slice`]: #method.as_uninit_slice-1
1294     ///
1295     /// # Safety
1296     ///
1297     /// When calling this method, you have to ensure that *either* the pointer is NULL *or*
1298     /// all of the following is true:
1299     ///
1300     /// * The pointer must be [valid] for reads and writes for `ptr.len() * mem::size_of::<T>()`
1301     ///   many bytes, and it must be properly aligned. This means in particular:
1302     ///
1303     ///     * The entire memory range of this slice must be contained within a single allocated object!
1304     ///       Slices can never span across multiple allocated objects.
1305     ///
1306     ///     * The pointer must be aligned even for zero-length slices. One
1307     ///       reason for this is that enum layout optimizations may rely on references
1308     ///       (including slices of any length) being aligned and non-null to distinguish
1309     ///       them from other data. You can obtain a pointer that is usable as `data`
1310     ///       for zero-length slices using [`NonNull::dangling()`].
1311     ///
1312     /// * The total size `ptr.len() * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
1313     ///   See the safety documentation of [`pointer::offset`].
1314     ///
1315     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
1316     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
1317     ///   In particular, for the duration of this lifetime, the memory the pointer points to must
1318     ///   not get accessed (read or written) through any other pointer.
1319     ///
1320     /// This applies even if the result of this method is unused!
1321     ///
1322     /// See also [`slice::from_raw_parts_mut`][].
1323     ///
1324     /// [valid]: crate::ptr#safety
1325     /// [`NonNull::dangling()`]: NonNull::dangling
1326     /// [`pointer::offset`]: ../std/primitive.pointer.html#method.offset
1327     #[inline]
1328     #[unstable(feature = "ptr_as_uninit", issue = "75402")]
1329     pub unsafe fn as_uninit_slice_mut<'a>(self) -> Option<&'a mut [MaybeUninit<T>]> {
1330         if self.is_null() {
1331             None
1332         } else {
1333             // SAFETY: the caller must uphold the safety contract for `as_uninit_slice_mut`.
1334             Some(unsafe { slice::from_raw_parts_mut(self as *mut MaybeUninit<T>, self.len()) })
1335         }
1336     }
1337 }
1338
1339 // Equality for pointers
1340 #[stable(feature = "rust1", since = "1.0.0")]
1341 impl<T: ?Sized> PartialEq for *mut T {
1342     #[inline]
1343     fn eq(&self, other: &*mut T) -> bool {
1344         *self == *other
1345     }
1346 }
1347
1348 #[stable(feature = "rust1", since = "1.0.0")]
1349 impl<T: ?Sized> Eq for *mut T {}
1350
1351 #[stable(feature = "rust1", since = "1.0.0")]
1352 impl<T: ?Sized> Ord for *mut T {
1353     #[inline]
1354     fn cmp(&self, other: &*mut T) -> Ordering {
1355         if self < other {
1356             Less
1357         } else if self == other {
1358             Equal
1359         } else {
1360             Greater
1361         }
1362     }
1363 }
1364
1365 #[stable(feature = "rust1", since = "1.0.0")]
1366 impl<T: ?Sized> PartialOrd for *mut T {
1367     #[inline]
1368     fn partial_cmp(&self, other: &*mut T) -> Option<Ordering> {
1369         Some(self.cmp(other))
1370     }
1371
1372     #[inline]
1373     fn lt(&self, other: &*mut T) -> bool {
1374         *self < *other
1375     }
1376
1377     #[inline]
1378     fn le(&self, other: &*mut T) -> bool {
1379         *self <= *other
1380     }
1381
1382     #[inline]
1383     fn gt(&self, other: &*mut T) -> bool {
1384         *self > *other
1385     }
1386
1387     #[inline]
1388     fn ge(&self, other: &*mut T) -> bool {
1389         *self >= *other
1390     }
1391 }