library/core/src/ptr/const_ptr.rs

   1 use super::*;
   2 use crate::cmp::Ordering::{self, Equal, Greater, Less};
   3 use crate::intrinsics;
   4 use crate::mem;
   5 use crate::slice::{self, SliceIndex};
   6
   7 impl<T: ?Sized> *const 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 s: &str = "Follow the rabbit";
  30     /// let ptr: *const u8 = s.as_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 *const u8).guaranteed_eq(null())
  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) -> *const U {
  47         self as _
  48     }
  49
  50     /// Use the pointer value in a new pointer of another type.
  51     ///
  52     /// In case `val` is a (fat) pointer to an unsized type, this operation
  53     /// will ignore the pointer part, whereas for (thin) pointers to sized
  54     /// types, this has the same effect as a simple cast.
  55     ///
  56     /// The resulting pointer will have provenance of `self`, i.e., for a fat
  57     /// pointer, this operation is semantically the same as creating a new
  58     /// fat pointer with the data pointer value of `self` but the metadata of
  59     /// `val`.
  60     ///
  61     /// # Examples
  62     ///
  63     /// This function is primarily useful for allowing byte-wise pointer
  64     /// arithmetic on potentially fat pointers:
  65     ///
  66     /// ```
  67     /// #![feature(set_ptr_value)]
  68     /// # use core::fmt::Debug;
  69     /// let arr: [i32; 3] = [1, 2, 3];
  70     /// let mut ptr = arr.as_ptr() as *const dyn Debug;
  71     /// let thin = ptr as *const u8;
  72     /// unsafe {
  73     ///     ptr = thin.add(8).with_metadata_of(ptr);
  74     ///     # assert_eq!(*(ptr as *const i32), 3);
  75     ///     println!("{:?}", &*ptr); // will print "3"
  76     /// }
  77     /// ```
  78     #[unstable(feature = "set_ptr_value", issue = "75091")]
  79     #[must_use = "returns a new pointer rather than modifying its argument"]
  80     #[inline]
  81     pub fn with_metadata_of<U>(self, mut val: *const U) -> *const U
  82     where
  83         U: ?Sized,
  84     {
  85         let target = &mut val as *mut *const U as *mut *const u8;
  86         // SAFETY: In case of a thin pointer, this operations is identical
  87         // to a simple assignment. In case of a fat pointer, with the current
  88         // fat pointer layout implementation, the first field of such a
  89         // pointer is always the data pointer, which is likewise assigned.
  90         unsafe { *target = self as *const u8 };
  91         val
  92     }
  93
  94     /// Changes constness without changing the type.
  95     ///
  96     /// This is a bit safer than `as` because it wouldn't silently change the type if the code is
  97     /// refactored.
  98     #[stable(feature = "ptr_const_cast", since = "CURRENT_RUSTC_VERSION")]
  99     #[rustc_const_stable(feature = "ptr_const_cast", since = "CURRENT_RUSTC_VERSION")]
 100     pub const fn cast_mut(self) -> *mut T {
 101         self as _
 102     }
 103
 104     /// Casts a pointer to its raw bits.
 105     ///
 106     /// This is equivalent to `as usize`, but is more specific to enhance readability.
 107     /// The inverse method is [`from_bits`](#method.from_bits).
 108     ///
 109     /// In particular, `*p as usize` and `p as usize` will both compile for
 110     /// pointers to numeric types but do very different things, so using this
 111     /// helps emphasize that reading the bits was intentional.
 112     ///
 113     /// # Examples
 114     ///
 115     /// ```
 116     /// #![feature(ptr_to_from_bits)]
 117     /// let array = [13, 42];
 118     /// let p0: *const i32 = &array[0];
 119     /// assert_eq!(<*const _>::from_bits(p0.to_bits()), p0);
 120     /// let p1: *const i32 = &array[1];
 121     /// assert_eq!(p1.to_bits() - p0.to_bits(), 4);
 122     /// ```
 123     #[unstable(feature = "ptr_to_from_bits", issue = "91126")]
 124     pub fn to_bits(self) -> usize
 125     where
 126         T: Sized,
 127     {
 128         self as usize
 129     }
 130
 131     /// Creates a pointer from its raw bits.
 132     ///
 133     /// This is equivalent to `as *const T`, but is more specific to enhance readability.
 134     /// The inverse method is [`to_bits`](#method.to_bits).
 135     ///
 136     /// # Examples
 137     ///
 138     /// ```
 139     /// #![feature(ptr_to_from_bits)]
 140     /// use std::ptr::NonNull;
 141     /// let dangling: *const u8 = NonNull::dangling().as_ptr();
 142     /// assert_eq!(<*const u8>::from_bits(1), dangling);
 143     /// ```
 144     #[unstable(feature = "ptr_to_from_bits", issue = "91126")]
 145     pub fn from_bits(bits: usize) -> Self
 146     where
 147         T: Sized,
 148     {
 149         bits as Self
 150     }
 151
 152     /// Gets the "address" portion of the pointer.
 153     ///
 154     /// This is similar to `self as usize`, which semantically discards *provenance* and
 155     /// *address-space* information. However, unlike `self as usize`, casting the returned address
 156     /// back to a pointer yields [`invalid`][], which is undefined behavior to dereference. To
 157     /// properly restore the lost information and obtain a dereferenceable pointer, use
 158     /// [`with_addr`][pointer::with_addr] or [`map_addr`][pointer::map_addr].
 159     ///
 160     /// If using those APIs is not possible because there is no way to preserve a pointer with the
 161     /// required provenance, use [`expose_addr`][pointer::expose_addr] and
 162     /// [`from_exposed_addr`][from_exposed_addr] instead. However, note that this makes
 163     /// your code less portable and less amenable to tools that check for compliance with the Rust
 164     /// memory model.
 165     ///
 166     /// On most platforms this will produce a value with the same bytes as the original
 167     /// pointer, because all the bytes are dedicated to describing the address.
 168     /// Platforms which need to store additional information in the pointer may
 169     /// perform a change of representation to produce a value containing only the address
 170     /// portion of the pointer. What that means is up to the platform to define.
 171     ///
 172     /// This API and its claimed semantics are part of the Strict Provenance experiment, and as such
 173     /// might change in the future (including possibly weakening this so it becomes wholly
 174     /// equivalent to `self as usize`). See the [module documentation][crate::ptr] for details.
 175     #[must_use]
 176     #[inline]
 177     #[unstable(feature = "strict_provenance", issue = "95228")]
 178     pub fn addr(self) -> usize
 179     where
 180         T: Sized,
 181     {
 182         // FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
 183         // SAFETY: Pointer-to-integer transmutes are valid (if you are okay with losing the
 184         // provenance).
 185         unsafe { mem::transmute(self) }
 186     }
 187
 188     /// Gets the "address" portion of the pointer, and 'exposes' the "provenance" part for future
 189     /// use in [`from_exposed_addr`][].
 190     ///
 191     /// This is equivalent to `self as usize`, which semantically discards *provenance* and
 192     /// *address-space* information. Furthermore, this (like the `as` cast) has the implicit
 193     /// side-effect of marking the provenance as 'exposed', so on platforms that support it you can
 194     /// later call [`from_exposed_addr`][] to reconstitute the original pointer including its
 195     /// provenance. (Reconstructing address space information, if required, is your responsibility.)
 196     ///
 197     /// Using this method means that code is *not* following Strict Provenance rules. Supporting
 198     /// [`from_exposed_addr`][] complicates specification and reasoning and may not be supported by
 199     /// tools that help you to stay conformant with the Rust memory model, so it is recommended to
 200     /// use [`addr`][pointer::addr] wherever possible.
 201     ///
 202     /// On most platforms this will produce a value with the same bytes as the original pointer,
 203     /// because all the bytes are dedicated to describing the address. Platforms which need to store
 204     /// additional information in the pointer may not support this operation, since the 'expose'
 205     /// side-effect which is required for [`from_exposed_addr`][] to work is typically not
 206     /// available.
 207     ///
 208     /// This API and its claimed semantics are part of the Strict Provenance experiment, see the
 209     /// [module documentation][crate::ptr] for details.
 210     ///
 211     /// [`from_exposed_addr`]: from_exposed_addr
 212     #[must_use]
 213     #[inline]
 214     #[unstable(feature = "strict_provenance", issue = "95228")]
 215     pub fn expose_addr(self) -> usize
 216     where
 217         T: Sized,
 218     {
 219         // FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
 220         self as usize
 221     }
 222
 223     /// Creates a new pointer with the given address.
 224     ///
 225     /// This performs the same operation as an `addr as ptr` cast, but copies
 226     /// the *address-space* and *provenance* of `self` to the new pointer.
 227     /// This allows us to dynamically preserve and propagate this important
 228     /// information in a way that is otherwise impossible with a unary cast.
 229     ///
 230     /// This is equivalent to using [`wrapping_offset`][pointer::wrapping_offset] to offset
 231     /// `self` to the given address, and therefore has all the same capabilities and restrictions.
 232     ///
 233     /// This API and its claimed semantics are part of the Strict Provenance experiment,
 234     /// see the [module documentation][crate::ptr] for details.
 235     #[must_use]
 236     #[inline]
 237     #[unstable(feature = "strict_provenance", issue = "95228")]
 238     pub fn with_addr(self, addr: usize) -> Self
 239     where
 240         T: Sized,
 241     {
 242         // FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
 243         //
 244         // In the mean-time, this operation is defined to be "as if" it was
 245         // a wrapping_offset, so we can emulate it as such. This should properly
 246         // restore pointer provenance even under today's compiler.
 247         let self_addr = self.addr() as isize;
 248         let dest_addr = addr as isize;
 249         let offset = dest_addr.wrapping_sub(self_addr);
 250
 251         // This is the canonical desugarring of this operation
 252         self.wrapping_byte_offset(offset)
 253     }
 254
 255     /// Creates a new pointer by mapping `self`'s address to a new one.
 256     ///
 257     /// This is a convenience for [`with_addr`][pointer::with_addr], see that method for details.
 258     ///
 259     /// This API and its claimed semantics are part of the Strict Provenance experiment,
 260     /// see the [module documentation][crate::ptr] for details.
 261     #[must_use]
 262     #[inline]
 263     #[unstable(feature = "strict_provenance", issue = "95228")]
 264     pub fn map_addr(self, f: impl FnOnce(usize) -> usize) -> Self
 265     where
 266         T: Sized,
 267     {
 268         self.with_addr(f(self.addr()))
 269     }
 270
 271     /// Decompose a (possibly wide) pointer into its address and metadata components.
 272     ///
 273     /// The pointer can be later reconstructed with [`from_raw_parts`].
 274     #[unstable(feature = "ptr_metadata", issue = "81513")]
 275     #[rustc_const_unstable(feature = "ptr_metadata", issue = "81513")]
 276     #[inline]
 277     pub const fn to_raw_parts(self) -> (*const (), <T as super::Pointee>::Metadata) {
 278         (self.cast(), metadata(self))
 279     }
 280
 281     /// Returns `None` if the pointer is null, or else returns a shared reference to
 282     /// the value wrapped in `Some`. If the value may be uninitialized, [`as_uninit_ref`]
 283     /// must be used instead.
 284     ///
 285     /// [`as_uninit_ref`]: #method.as_uninit_ref
 286     ///
 287     /// # Safety
 288     ///
 289     /// When calling this method, you have to ensure that *either* the pointer is null *or*
 290     /// all of the following is true:
 291     ///
 292     /// * The pointer must be properly aligned.
 293     ///
 294     /// * It must be "dereferenceable" in the sense defined in [the module documentation].
 295     ///
 296     /// * The pointer must point to an initialized instance of `T`.
 297     ///
 298     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
 299     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
 300     ///   In particular, while this reference exists, the memory the pointer points to must
 301     ///   not get mutated (except inside `UnsafeCell`).
 302     ///
 303     /// This applies even if the result of this method is unused!
 304     /// (The part about being initialized is not yet fully decided, but until
 305     /// it is, the only safe approach is to ensure that they are indeed initialized.)
 306     ///
 307     /// [the module documentation]: crate::ptr#safety
 308     ///
 309     /// # Examples
 310     ///
 311     /// Basic usage:
 312     ///
 313     /// ```
 314     /// let ptr: *const u8 = &10u8 as *const u8;
 315     ///
 316     /// unsafe {
 317     ///     if let Some(val_back) = ptr.as_ref() {
 318     ///         println!("We got back the value: {val_back}!");
 319     ///     }
 320     /// }
 321     /// ```
 322     ///
 323     /// # Null-unchecked version
 324     ///
 325     /// If you are sure the pointer can never be null and are looking for some kind of
 326     /// `as_ref_unchecked` that returns the `&T` instead of `Option<&T>`, know that you can
 327     /// dereference the pointer directly.
 328     ///
 329     /// ```
 330     /// let ptr: *const u8 = &10u8 as *const u8;
 331     ///
 332     /// unsafe {
 333     ///     let val_back = &*ptr;
 334     ///     println!("We got back the value: {val_back}!");
 335     /// }
 336     /// ```
 337     #[stable(feature = "ptr_as_ref", since = "1.9.0")]
 338     #[rustc_const_unstable(feature = "const_ptr_as_ref", issue = "91822")]
 339     #[inline]
 340     pub const unsafe fn as_ref<'a>(self) -> Option<&'a T> {
 341         // SAFETY: the caller must guarantee that `self` is valid
 342         // for a reference if it isn't null.
 343         if self.is_null() { None } else { unsafe { Some(&*self) } }
 344     }
 345
 346     /// Returns `None` if the pointer is null, or else returns a shared reference to
 347     /// the value wrapped in `Some`. In contrast to [`as_ref`], this does not require
 348     /// that the value has to be initialized.
 349     ///
 350     /// [`as_ref`]: #method.as_ref
 351     ///
 352     /// # Safety
 353     ///
 354     /// When calling this method, you have to ensure that *either* the pointer is null *or*
 355     /// all of the following is true:
 356     ///
 357     /// * The pointer must be properly aligned.
 358     ///
 359     /// * It must be "dereferenceable" in the sense defined in [the module documentation].
 360     ///
 361     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
 362     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
 363     ///   In particular, while this reference exists, the memory the pointer points to must
 364     ///   not get mutated (except inside `UnsafeCell`).
 365     ///
 366     /// This applies even if the result of this method is unused!
 367     ///
 368     /// [the module documentation]: crate::ptr#safety
 369     ///
 370     /// # Examples
 371     ///
 372     /// Basic usage:
 373     ///
 374     /// ```
 375     /// #![feature(ptr_as_uninit)]
 376     ///
 377     /// let ptr: *const u8 = &10u8 as *const u8;
 378     ///
 379     /// unsafe {
 380     ///     if let Some(val_back) = ptr.as_uninit_ref() {
 381     ///         println!("We got back the value: {}!", val_back.assume_init());
 382     ///     }
 383     /// }
 384     /// ```
 385     #[inline]
 386     #[unstable(feature = "ptr_as_uninit", issue = "75402")]
 387     #[rustc_const_unstable(feature = "const_ptr_as_ref", issue = "91822")]
 388     pub const unsafe fn as_uninit_ref<'a>(self) -> Option<&'a MaybeUninit<T>>
 389     where
 390         T: Sized,
 391     {
 392         // SAFETY: the caller must guarantee that `self` meets all the
 393         // requirements for a reference.
 394         if self.is_null() { None } else { Some(unsafe { &*(self as *const MaybeUninit<T>) }) }
 395     }
 396
 397     /// Calculates the offset from a pointer.
 398     ///
 399     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 400     /// offset of `3 * size_of::<T>()` bytes.
 401     ///
 402     /// # Safety
 403     ///
 404     /// If any of the following conditions are violated, the result is Undefined
 405     /// Behavior:
 406     ///
 407     /// * Both the starting and resulting pointer must be either in bounds or one
 408     ///   byte past the end of the same [allocated object].
 409     ///
 410     /// * The computed offset, **in bytes**, cannot overflow an `isize`.
 411     ///
 412     /// * The offset being in bounds cannot rely on "wrapping around" the address
 413     ///   space. That is, the infinite-precision sum, **in bytes** must fit in a usize.
 414     ///
 415     /// The compiler and standard library generally tries to ensure allocations
 416     /// never reach a size where an offset is a concern. For instance, `Vec`
 417     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 418     /// `vec.as_ptr().add(vec.len())` is always safe.
 419     ///
 420     /// Most platforms fundamentally can't even construct such an allocation.
 421     /// For instance, no known 64-bit platform can ever serve a request
 422     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 423     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 424     /// more than `isize::MAX` bytes with things like Physical Address
 425     /// Extension. As such, memory acquired directly from allocators or memory
 426     /// mapped files *may* be too large to handle with this function.
 427     ///
 428     /// Consider using [`wrapping_offset`] instead if these constraints are
 429     /// difficult to satisfy. The only advantage of this method is that it
 430     /// enables more aggressive compiler optimizations.
 431     ///
 432     /// [`wrapping_offset`]: #method.wrapping_offset
 433     /// [allocated object]: crate::ptr#allocated-object
 434     ///
 435     /// # Examples
 436     ///
 437     /// Basic usage:
 438     ///
 439     /// ```
 440     /// let s: &str = "123";
 441     /// let ptr: *const u8 = s.as_ptr();
 442     ///
 443     /// unsafe {
 444     ///     println!("{}", *ptr.offset(1) as char);
 445     ///     println!("{}", *ptr.offset(2) as char);
 446     /// }
 447     /// ```
 448     #[stable(feature = "rust1", since = "1.0.0")]
 449     #[must_use = "returns a new pointer rather than modifying its argument"]
 450     #[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
 451     #[inline(always)]
 452     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 453     pub const unsafe fn offset(self, count: isize) -> *const T
 454     where
 455         T: Sized,
 456     {
 457         // SAFETY: the caller must uphold the safety contract for `offset`.
 458         unsafe { intrinsics::offset(self, count) }
 459     }
 460
 461     /// Calculates the offset from a pointer in bytes.
 462     ///
 463     /// `count` is in units of **bytes**.
 464     ///
 465     /// This is purely a convenience for casting to a `u8` pointer and
 466     /// using [offset][pointer::offset] on it. See that method for documentation
 467     /// and safety requirements.
 468     ///
 469     /// For non-`Sized` pointees this operation changes only the data pointer,
 470     /// leaving the metadata untouched.
 471     #[must_use]
 472     #[inline(always)]
 473     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
 474     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
 475     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 476     pub const unsafe fn byte_offset(self, count: isize) -> Self {
 477         // SAFETY: the caller must uphold the safety contract for `offset`.
 478         let this = unsafe { self.cast::<u8>().offset(count).cast::<()>() };
 479         from_raw_parts::<T>(this, metadata(self))
 480     }
 481
 482     /// Calculates the offset from a pointer using wrapping arithmetic.
 483     ///
 484     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 485     /// offset of `3 * size_of::<T>()` bytes.
 486     ///
 487     /// # Safety
 488     ///
 489     /// This operation itself is always safe, but using the resulting pointer is not.
 490     ///
 491     /// The resulting pointer "remembers" the [allocated object] that `self` points to; it must not
 492     /// be used to read or write other allocated objects.
 493     ///
 494     /// In other words, `let z = x.wrapping_offset((y as isize) - (x as isize))` does *not* make `z`
 495     /// the same as `y` even if we assume `T` has size `1` and there is no overflow: `z` is still
 496     /// attached to the object `x` is attached to, and dereferencing it is Undefined Behavior unless
 497     /// `x` and `y` point into the same allocated object.
 498     ///
 499     /// Compared to [`offset`], this method basically delays the requirement of staying within the
 500     /// same allocated object: [`offset`] is immediate Undefined Behavior when crossing object
 501     /// boundaries; `wrapping_offset` produces a pointer but still leads to Undefined Behavior if a
 502     /// pointer is dereferenced when it is out-of-bounds of the object it is attached to. [`offset`]
 503     /// can be optimized better and is thus preferable in performance-sensitive code.
 504     ///
 505     /// The delayed check only considers the value of the pointer that was dereferenced, not the
 506     /// intermediate values used during the computation of the final result. For example,
 507     /// `x.wrapping_offset(o).wrapping_offset(o.wrapping_neg())` is always the same as `x`. In other
 508     /// words, leaving the allocated object and then re-entering it later is permitted.
 509     ///
 510     /// [`offset`]: #method.offset
 511     /// [allocated object]: crate::ptr#allocated-object
 512     ///
 513     /// # Examples
 514     ///
 515     /// Basic usage:
 516     ///
 517     /// ```
 518     /// // Iterate using a raw pointer in increments of two elements
 519     /// let data = [1u8, 2, 3, 4, 5];
 520     /// let mut ptr: *const u8 = data.as_ptr();
 521     /// let step = 2;
 522     /// let end_rounded_up = ptr.wrapping_offset(6);
 523     ///
 524     /// // This loop prints "1, 3, 5, "
 525     /// while ptr != end_rounded_up {
 526     ///     unsafe {
 527     ///         print!("{}, ", *ptr);
 528     ///     }
 529     ///     ptr = ptr.wrapping_offset(step);
 530     /// }
 531     /// ```
 532     #[stable(feature = "ptr_wrapping_offset", since = "1.16.0")]
 533     #[must_use = "returns a new pointer rather than modifying its argument"]
 534     #[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
 535     #[inline(always)]
 536     pub const fn wrapping_offset(self, count: isize) -> *const T
 537     where
 538         T: Sized,
 539     {
 540         // SAFETY: the `arith_offset` intrinsic has no prerequisites to be called.
 541         unsafe { intrinsics::arith_offset(self, count) }
 542     }
 543
 544     /// Calculates the offset from a pointer in bytes using wrapping arithmetic.
 545     ///
 546     /// `count` is in units of **bytes**.
 547     ///
 548     /// This is purely a convenience for casting to a `u8` pointer and
 549     /// using [wrapping_offset][pointer::wrapping_offset] on it. See that method
 550     /// for documentation.
 551     ///
 552     /// For non-`Sized` pointees this operation changes only the data pointer,
 553     /// leaving the metadata untouched.
 554     #[must_use]
 555     #[inline(always)]
 556     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
 557     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
 558     pub const fn wrapping_byte_offset(self, count: isize) -> Self {
 559         from_raw_parts::<T>(self.cast::<u8>().wrapping_offset(count).cast::<()>(), metadata(self))
 560     }
 561
 562     /// Masks out bits of the pointer according to a mask.
 563     ///
 564     /// This is convenience for `ptr.map_addr(|a| a & mask)`.
 565     ///
 566     /// For non-`Sized` pointees this operation changes only the data pointer,
 567     /// leaving the metadata untouched.
 568     #[cfg(not(bootstrap))]
 569     #[unstable(feature = "ptr_mask", issue = "98290")]
 570     #[must_use = "returns a new pointer rather than modifying its argument"]
 571     #[inline(always)]
 572     pub fn mask(self, mask: usize) -> *const T {
 573         let this = intrinsics::ptr_mask(self.cast::<()>(), mask);
 574         from_raw_parts::<T>(this, metadata(self))
 575     }
 576
 577     /// Calculates the distance between two pointers. The returned value is in
 578     /// units of T: the distance in bytes divided by `mem::size_of::<T>()`.
 579     ///
 580     /// This function is the inverse of [`offset`].
 581     ///
 582     /// [`offset`]: #method.offset
 583     ///
 584     /// # Safety
 585     ///
 586     /// If any of the following conditions are violated, the result is Undefined
 587     /// Behavior:
 588     ///
 589     /// * Both the starting and other pointer must be either in bounds or one
 590     ///   byte past the end of the same [allocated object].
 591     ///
 592     /// * Both pointers must be *derived from* a pointer to the same object.
 593     ///   (See below for an example.)
 594     ///
 595     /// * The distance between the pointers, in bytes, must be an exact multiple
 596     ///   of the size of `T`.
 597     ///
 598     /// * The distance between the pointers, **in bytes**, cannot overflow an `isize`.
 599     ///
 600     /// * The distance being in bounds cannot rely on "wrapping around" the address space.
 601     ///
 602     /// Rust types are never larger than `isize::MAX` and Rust allocations never wrap around the
 603     /// address space, so two pointers within some value of any Rust type `T` will always satisfy
 604     /// the last two conditions. The standard library also generally ensures that allocations
 605     /// never reach a size where an offset is a concern. For instance, `Vec` and `Box` ensure they
 606     /// never allocate more than `isize::MAX` bytes, so `ptr_into_vec.offset_from(vec.as_ptr())`
 607     /// always satisfies the last two conditions.
 608     ///
 609     /// Most platforms fundamentally can't even construct such a large allocation.
 610     /// For instance, no known 64-bit platform can ever serve a request
 611     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 612     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 613     /// more than `isize::MAX` bytes with things like Physical Address
 614     /// Extension. As such, memory acquired directly from allocators or memory
 615     /// mapped files *may* be too large to handle with this function.
 616     /// (Note that [`offset`] and [`add`] also have a similar limitation and hence cannot be used on
 617     /// such large allocations either.)
 618     ///
 619     /// [`add`]: #method.add
 620     /// [allocated object]: crate::ptr#allocated-object
 621     ///
 622     /// # Panics
 623     ///
 624     /// This function panics if `T` is a Zero-Sized Type ("ZST").
 625     ///
 626     /// # Examples
 627     ///
 628     /// Basic usage:
 629     ///
 630     /// ```
 631     /// let a = [0; 5];
 632     /// let ptr1: *const i32 = &a[1];
 633     /// let ptr2: *const i32 = &a[3];
 634     /// unsafe {
 635     ///     assert_eq!(ptr2.offset_from(ptr1), 2);
 636     ///     assert_eq!(ptr1.offset_from(ptr2), -2);
 637     ///     assert_eq!(ptr1.offset(2), ptr2);
 638     ///     assert_eq!(ptr2.offset(-2), ptr1);
 639     /// }
 640     /// ```
 641     ///
 642     /// *Incorrect* usage:
 643     ///
 644     /// ```rust,no_run
 645     /// let ptr1 = Box::into_raw(Box::new(0u8)) as *const u8;
 646     /// let ptr2 = Box::into_raw(Box::new(1u8)) as *const u8;
 647     /// let diff = (ptr2 as isize).wrapping_sub(ptr1 as isize);
 648     /// // Make ptr2_other an "alias" of ptr2, but derived from ptr1.
 649     /// let ptr2_other = (ptr1 as *const u8).wrapping_offset(diff);
 650     /// assert_eq!(ptr2 as usize, ptr2_other as usize);
 651     /// // Since ptr2_other and ptr2 are derived from pointers to different objects,
 652     /// // computing their offset is undefined behavior, even though
 653     /// // they point to the same address!
 654     /// unsafe {
 655     ///     let zero = ptr2_other.offset_from(ptr2); // Undefined Behavior
 656     /// }
 657     /// ```
 658     #[stable(feature = "ptr_offset_from", since = "1.47.0")]
 659     #[rustc_const_stable(feature = "const_ptr_offset_from", since = "1.65.0")]
 660     #[inline]
 661     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 662     pub const unsafe fn offset_from(self, origin: *const T) -> isize
 663     where
 664         T: Sized,
 665     {
 666         let pointee_size = mem::size_of::<T>();
 667         assert!(0 < pointee_size && pointee_size <= isize::MAX as usize);
 668         // SAFETY: the caller must uphold the safety contract for `ptr_offset_from`.
 669         unsafe { intrinsics::ptr_offset_from(self, origin) }
 670     }
 671
 672     /// Calculates the distance between two pointers. The returned value is in
 673     /// units of **bytes**.
 674     ///
 675     /// This is purely a convenience for casting to a `u8` pointer and
 676     /// using [offset_from][pointer::offset_from] on it. See that method for
 677     /// documentation and safety requirements.
 678     ///
 679     /// For non-`Sized` pointees this operation considers only the data pointers,
 680     /// ignoring the metadata.
 681     #[inline(always)]
 682     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
 683     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
 684     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 685     pub const unsafe fn byte_offset_from(self, origin: *const T) -> isize {
 686         // SAFETY: the caller must uphold the safety contract for `offset_from`.
 687         unsafe { self.cast::<u8>().offset_from(origin.cast::<u8>()) }
 688     }
 689
 690     /// Calculates the distance between two pointers, *where it's known that
 691     /// `self` is equal to or greater than `origin`*. The returned value is in
 692     /// units of T: the distance in bytes is divided by `mem::size_of::<T>()`.
 693     ///
 694     /// This computes the same value that [`offset_from`](#method.offset_from)
 695     /// would compute, but with the added precondition that that the offset is
 696     /// guaranteed to be non-negative.  This method is equivalent to
 697     /// `usize::from(self.offset_from(origin)).unwrap_unchecked()`,
 698     /// but it provides slightly more information to the optimizer, which can
 699     /// sometimes allow it to optimize slightly better with some backends.
 700     ///
 701     /// This method can be though of as recovering the `count` that was passed
 702     /// to [`add`](#method.add) (or, with the parameters in the other order,
 703     /// to [`sub`](#method.sub)).  The following are all equivalent, assuming
 704     /// that their safety preconditions are met:
 705     /// ```rust
 706     /// # #![feature(ptr_sub_ptr)]
 707     /// # unsafe fn blah(ptr: *const i32, origin: *const i32, count: usize) -> bool {
 708     /// ptr.sub_ptr(origin) == count
 709     /// # &&
 710     /// origin.add(count) == ptr
 711     /// # &&
 712     /// ptr.sub(count) == origin
 713     /// # }
 714     /// ```
 715     ///
 716     /// # Safety
 717     ///
 718     /// - The distance between the pointers must be non-negative (`self >= origin`)
 719     ///
 720     /// - *All* the safety conditions of [`offset_from`](#method.offset_from)
 721     ///   apply to this method as well; see it for the full details.
 722     ///
 723     /// Importantly, despite the return type of this method being able to represent
 724     /// a larger offset, it's still *not permitted* to pass pointers which differ
 725     /// by more than `isize::MAX` *bytes*.  As such, the result of this method will
 726     /// always be less than or equal to `isize::MAX as usize`.
 727     ///
 728     /// # Panics
 729     ///
 730     /// This function panics if `T` is a Zero-Sized Type ("ZST").
 731     ///
 732     /// # Examples
 733     ///
 734     /// ```
 735     /// #![feature(ptr_sub_ptr)]
 736     ///
 737     /// let a = [0; 5];
 738     /// let ptr1: *const i32 = &a[1];
 739     /// let ptr2: *const i32 = &a[3];
 740     /// unsafe {
 741     ///     assert_eq!(ptr2.sub_ptr(ptr1), 2);
 742     ///     assert_eq!(ptr1.add(2), ptr2);
 743     ///     assert_eq!(ptr2.sub(2), ptr1);
 744     ///     assert_eq!(ptr2.sub_ptr(ptr2), 0);
 745     /// }
 746     ///
 747     /// // This would be incorrect, as the pointers are not correctly ordered:
 748     /// // ptr1.sub_ptr(ptr2)
 749     /// ```
 750     #[unstable(feature = "ptr_sub_ptr", issue = "95892")]
 751     #[rustc_const_unstable(feature = "const_ptr_sub_ptr", issue = "95892")]
 752     #[inline]
 753     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 754     pub const unsafe fn sub_ptr(self, origin: *const T) -> usize
 755     where
 756         T: Sized,
 757     {
 758         let this = self;
 759         // SAFETY: The comparison has no side-effects, and the intrinsic
 760         // does this check internally in the CTFE implementation.
 761         unsafe {
 762             assert_unsafe_precondition!([T](this: *const T, origin: *const T) => this >= origin)
 763         };
 764
 765         let pointee_size = mem::size_of::<T>();
 766         assert!(0 < pointee_size && pointee_size <= isize::MAX as usize);
 767         // SAFETY: the caller must uphold the safety contract for `ptr_offset_from_unsigned`.
 768         unsafe { intrinsics::ptr_offset_from_unsigned(self, origin) }
 769     }
 770
 771     /// Returns whether two pointers are guaranteed to be equal.
 772     ///
 773     /// At runtime this function behaves like `self == other`.
 774     /// However, in some contexts (e.g., compile-time evaluation),
 775     /// it is not always possible to determine equality of two pointers, so this function may
 776     /// spuriously return `false` for pointers that later actually turn out to be equal.
 777     /// But when it returns `true`, the pointers are guaranteed to be equal.
 778     ///
 779     /// This function is the mirror of [`guaranteed_ne`], but not its inverse. There are pointer
 780     /// comparisons for which both functions return `false`.
 781     ///
 782     /// [`guaranteed_ne`]: #method.guaranteed_ne
 783     ///
 784     /// The return value may change depending on the compiler version and unsafe code must not
 785     /// rely on the result of this function for soundness. It is suggested to only use this function
 786     /// for performance optimizations where spurious `false` return values by this function do not
 787     /// affect the outcome, but just the performance.
 788     /// The consequences of using this method to make runtime and compile-time code behave
 789     /// differently have not been explored. This method should not be used to introduce such
 790     /// differences, and it should also not be stabilized before we have a better understanding
 791     /// of this issue.
 792     #[unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 793     #[rustc_const_unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 794     #[inline]
 795     pub const fn guaranteed_eq(self, other: *const T) -> bool
 796     where
 797         T: Sized,
 798     {
 799         intrinsics::ptr_guaranteed_eq(self, other)
 800     }
 801
 802     /// Returns whether two pointers are guaranteed to be unequal.
 803     ///
 804     /// At runtime this function behaves like `self != other`.
 805     /// However, in some contexts (e.g., compile-time evaluation),
 806     /// it is not always possible to determine the inequality of two pointers, so this function may
 807     /// spuriously return `false` for pointers that later actually turn out to be unequal.
 808     /// But when it returns `true`, the pointers are guaranteed to be unequal.
 809     ///
 810     /// This function is the mirror of [`guaranteed_eq`], but not its inverse. There are pointer
 811     /// comparisons for which both functions return `false`.
 812     ///
 813     /// [`guaranteed_eq`]: #method.guaranteed_eq
 814     ///
 815     /// The return value may change depending on the compiler version and unsafe code must not
 816     /// rely on the result of this function for soundness. It is suggested to only use this function
 817     /// for performance optimizations where spurious `false` return values by this function do not
 818     /// affect the outcome, but just the performance.
 819     /// The consequences of using this method to make runtime and compile-time code behave
 820     /// differently have not been explored. This method should not be used to introduce such
 821     /// differences, and it should also not be stabilized before we have a better understanding
 822     /// of this issue.
 823     #[unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 824     #[rustc_const_unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
 825     #[inline]
 826     pub const fn guaranteed_ne(self, other: *const T) -> bool
 827     where
 828         T: Sized,
 829     {
 830         intrinsics::ptr_guaranteed_ne(self, other)
 831     }
 832
 833     /// Calculates the offset from a pointer (convenience for `.offset(count as isize)`).
 834     ///
 835     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 836     /// offset of `3 * size_of::<T>()` bytes.
 837     ///
 838     /// # Safety
 839     ///
 840     /// If any of the following conditions are violated, the result is Undefined
 841     /// Behavior:
 842     ///
 843     /// * Both the starting and resulting pointer must be either in bounds or one
 844     ///   byte past the end of the same [allocated object].
 845     ///
 846     /// * The computed offset, **in bytes**, cannot overflow an `isize`.
 847     ///
 848     /// * The offset being in bounds cannot rely on "wrapping around" the address
 849     ///   space. That is, the infinite-precision sum must fit in a `usize`.
 850     ///
 851     /// The compiler and standard library generally tries to ensure allocations
 852     /// never reach a size where an offset is a concern. For instance, `Vec`
 853     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 854     /// `vec.as_ptr().add(vec.len())` is always safe.
 855     ///
 856     /// Most platforms fundamentally can't even construct such an allocation.
 857     /// For instance, no known 64-bit platform can ever serve a request
 858     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 859     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 860     /// more than `isize::MAX` bytes with things like Physical Address
 861     /// Extension. As such, memory acquired directly from allocators or memory
 862     /// mapped files *may* be too large to handle with this function.
 863     ///
 864     /// Consider using [`wrapping_add`] instead if these constraints are
 865     /// difficult to satisfy. The only advantage of this method is that it
 866     /// enables more aggressive compiler optimizations.
 867     ///
 868     /// [`wrapping_add`]: #method.wrapping_add
 869     /// [allocated object]: crate::ptr#allocated-object
 870     ///
 871     /// # Examples
 872     ///
 873     /// Basic usage:
 874     ///
 875     /// ```
 876     /// let s: &str = "123";
 877     /// let ptr: *const u8 = s.as_ptr();
 878     ///
 879     /// unsafe {
 880     ///     println!("{}", *ptr.add(1) as char);
 881     ///     println!("{}", *ptr.add(2) as char);
 882     /// }
 883     /// ```
 884     #[stable(feature = "pointer_methods", since = "1.26.0")]
 885     #[must_use = "returns a new pointer rather than modifying its argument"]
 886     #[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
 887     #[inline(always)]
 888     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 889     pub const unsafe fn add(self, count: usize) -> Self
 890     where
 891         T: Sized,
 892     {
 893         // SAFETY: the caller must uphold the safety contract for `offset`.
 894         unsafe { self.offset(count as isize) }
 895     }
 896
 897     /// Calculates the offset from a pointer in bytes (convenience for `.byte_offset(count as isize)`).
 898     ///
 899     /// `count` is in units of bytes.
 900     ///
 901     /// This is purely a convenience for casting to a `u8` pointer and
 902     /// using [add][pointer::add] on it. See that method for documentation
 903     /// and safety requirements.
 904     ///
 905     /// For non-`Sized` pointees this operation changes only the data pointer,
 906     /// leaving the metadata untouched.
 907     #[must_use]
 908     #[inline(always)]
 909     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
 910     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
 911     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 912     pub const unsafe fn byte_add(self, count: usize) -> Self {
 913         // SAFETY: the caller must uphold the safety contract for `add`.
 914         let this = unsafe { self.cast::<u8>().add(count).cast::<()>() };
 915         from_raw_parts::<T>(this, metadata(self))
 916     }
 917
 918     /// Calculates the offset from a pointer (convenience for
 919     /// `.offset((count as isize).wrapping_neg())`).
 920     ///
 921     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
 922     /// offset of `3 * size_of::<T>()` bytes.
 923     ///
 924     /// # Safety
 925     ///
 926     /// If any of the following conditions are violated, the result is Undefined
 927     /// Behavior:
 928     ///
 929     /// * Both the starting and resulting pointer must be either in bounds or one
 930     ///   byte past the end of the same [allocated object].
 931     ///
 932     /// * The computed offset cannot exceed `isize::MAX` **bytes**.
 933     ///
 934     /// * The offset being in bounds cannot rely on "wrapping around" the address
 935     ///   space. That is, the infinite-precision sum must fit in a usize.
 936     ///
 937     /// The compiler and standard library generally tries to ensure allocations
 938     /// never reach a size where an offset is a concern. For instance, `Vec`
 939     /// and `Box` ensure they never allocate more than `isize::MAX` bytes, so
 940     /// `vec.as_ptr().add(vec.len()).sub(vec.len())` is always safe.
 941     ///
 942     /// Most platforms fundamentally can't even construct such an allocation.
 943     /// For instance, no known 64-bit platform can ever serve a request
 944     /// for 2<sup>63</sup> bytes due to page-table limitations or splitting the address space.
 945     /// However, some 32-bit and 16-bit platforms may successfully serve a request for
 946     /// more than `isize::MAX` bytes with things like Physical Address
 947     /// Extension. As such, memory acquired directly from allocators or memory
 948     /// mapped files *may* be too large to handle with this function.
 949     ///
 950     /// Consider using [`wrapping_sub`] instead if these constraints are
 951     /// difficult to satisfy. The only advantage of this method is that it
 952     /// enables more aggressive compiler optimizations.
 953     ///
 954     /// [`wrapping_sub`]: #method.wrapping_sub
 955     /// [allocated object]: crate::ptr#allocated-object
 956     ///
 957     /// # Examples
 958     ///
 959     /// Basic usage:
 960     ///
 961     /// ```
 962     /// let s: &str = "123";
 963     ///
 964     /// unsafe {
 965     ///     let end: *const u8 = s.as_ptr().add(3);
 966     ///     println!("{}", *end.sub(1) as char);
 967     ///     println!("{}", *end.sub(2) as char);
 968     /// }
 969     /// ```
 970     #[stable(feature = "pointer_methods", since = "1.26.0")]
 971     #[must_use = "returns a new pointer rather than modifying its argument"]
 972     #[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
 973     #[inline]
 974     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 975     pub const unsafe fn sub(self, count: usize) -> Self
 976     where
 977         T: Sized,
 978     {
 979         // SAFETY: the caller must uphold the safety contract for `offset`.
 980         unsafe { self.offset((count as isize).wrapping_neg()) }
 981     }
 982
 983     /// Calculates the offset from a pointer in bytes (convenience for
 984     /// `.byte_offset((count as isize).wrapping_neg())`).
 985     ///
 986     /// `count` is in units of bytes.
 987     ///
 988     /// This is purely a convenience for casting to a `u8` pointer and
 989     /// using [sub][pointer::sub] on it. See that method for documentation
 990     /// and safety requirements.
 991     ///
 992     /// For non-`Sized` pointees this operation changes only the data pointer,
 993     /// leaving the metadata untouched.
 994     #[must_use]
 995     #[inline(always)]
 996     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
 997     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
 998     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
 999     pub const unsafe fn byte_sub(self, count: usize) -> Self {
1000         // SAFETY: the caller must uphold the safety contract for `sub`.
1001         let this = unsafe { self.cast::<u8>().sub(count).cast::<()>() };
1002         from_raw_parts::<T>(this, metadata(self))
1003     }
1004
1005     /// Calculates the offset from a pointer using wrapping arithmetic.
1006     /// (convenience for `.wrapping_offset(count as isize)`)
1007     ///
1008     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
1009     /// offset of `3 * size_of::<T>()` bytes.
1010     ///
1011     /// # Safety
1012     ///
1013     /// This operation itself is always safe, but using the resulting pointer is not.
1014     ///
1015     /// The resulting pointer "remembers" the [allocated object] that `self` points to; it must not
1016     /// be used to read or write other allocated objects.
1017     ///
1018     /// In other words, `let z = x.wrapping_add((y as usize) - (x as usize))` does *not* make `z`
1019     /// the same as `y` even if we assume `T` has size `1` and there is no overflow: `z` is still
1020     /// attached to the object `x` is attached to, and dereferencing it is Undefined Behavior unless
1021     /// `x` and `y` point into the same allocated object.
1022     ///
1023     /// Compared to [`add`], this method basically delays the requirement of staying within the
1024     /// same allocated object: [`add`] is immediate Undefined Behavior when crossing object
1025     /// boundaries; `wrapping_add` produces a pointer but still leads to Undefined Behavior if a
1026     /// pointer is dereferenced when it is out-of-bounds of the object it is attached to. [`add`]
1027     /// can be optimized better and is thus preferable in performance-sensitive code.
1028     ///
1029     /// The delayed check only considers the value of the pointer that was dereferenced, not the
1030     /// intermediate values used during the computation of the final result. For example,
1031     /// `x.wrapping_add(o).wrapping_sub(o)` is always the same as `x`. In other words, leaving the
1032     /// allocated object and then re-entering it later is permitted.
1033     ///
1034     /// [`add`]: #method.add
1035     /// [allocated object]: crate::ptr#allocated-object
1036     ///
1037     /// # Examples
1038     ///
1039     /// Basic usage:
1040     ///
1041     /// ```
1042     /// // Iterate using a raw pointer in increments of two elements
1043     /// let data = [1u8, 2, 3, 4, 5];
1044     /// let mut ptr: *const u8 = data.as_ptr();
1045     /// let step = 2;
1046     /// let end_rounded_up = ptr.wrapping_add(6);
1047     ///
1048     /// // This loop prints "1, 3, 5, "
1049     /// while ptr != end_rounded_up {
1050     ///     unsafe {
1051     ///         print!("{}, ", *ptr);
1052     ///     }
1053     ///     ptr = ptr.wrapping_add(step);
1054     /// }
1055     /// ```
1056     #[stable(feature = "pointer_methods", since = "1.26.0")]
1057     #[must_use = "returns a new pointer rather than modifying its argument"]
1058     #[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
1059     #[inline(always)]
1060     pub const fn wrapping_add(self, count: usize) -> Self
1061     where
1062         T: Sized,
1063     {
1064         self.wrapping_offset(count as isize)
1065     }
1066
1067     /// Calculates the offset from a pointer in bytes using wrapping arithmetic.
1068     /// (convenience for `.wrapping_byte_offset(count as isize)`)
1069     ///
1070     /// `count` is in units of bytes.
1071     ///
1072     /// This is purely a convenience for casting to a `u8` pointer and
1073     /// using [wrapping_add][pointer::wrapping_add] on it. See that method for documentation.
1074     ///
1075     /// For non-`Sized` pointees this operation changes only the data pointer,
1076     /// leaving the metadata untouched.
1077     #[must_use]
1078     #[inline(always)]
1079     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
1080     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
1081     pub const fn wrapping_byte_add(self, count: usize) -> Self {
1082         from_raw_parts::<T>(self.cast::<u8>().wrapping_add(count).cast::<()>(), metadata(self))
1083     }
1084
1085     /// Calculates the offset from a pointer using wrapping arithmetic.
1086     /// (convenience for `.wrapping_offset((count as isize).wrapping_neg())`)
1087     ///
1088     /// `count` is in units of T; e.g., a `count` of 3 represents a pointer
1089     /// offset of `3 * size_of::<T>()` bytes.
1090     ///
1091     /// # Safety
1092     ///
1093     /// This operation itself is always safe, but using the resulting pointer is not.
1094     ///
1095     /// The resulting pointer "remembers" the [allocated object] that `self` points to; it must not
1096     /// be used to read or write other allocated objects.
1097     ///
1098     /// In other words, `let z = x.wrapping_sub((x as usize) - (y as usize))` does *not* make `z`
1099     /// the same as `y` even if we assume `T` has size `1` and there is no overflow: `z` is still
1100     /// attached to the object `x` is attached to, and dereferencing it is Undefined Behavior unless
1101     /// `x` and `y` point into the same allocated object.
1102     ///
1103     /// Compared to [`sub`], this method basically delays the requirement of staying within the
1104     /// same allocated object: [`sub`] is immediate Undefined Behavior when crossing object
1105     /// boundaries; `wrapping_sub` produces a pointer but still leads to Undefined Behavior if a
1106     /// pointer is dereferenced when it is out-of-bounds of the object it is attached to. [`sub`]
1107     /// can be optimized better and is thus preferable in performance-sensitive code.
1108     ///
1109     /// The delayed check only considers the value of the pointer that was dereferenced, not the
1110     /// intermediate values used during the computation of the final result. For example,
1111     /// `x.wrapping_add(o).wrapping_sub(o)` is always the same as `x`. In other words, leaving the
1112     /// allocated object and then re-entering it later is permitted.
1113     ///
1114     /// [`sub`]: #method.sub
1115     /// [allocated object]: crate::ptr#allocated-object
1116     ///
1117     /// # Examples
1118     ///
1119     /// Basic usage:
1120     ///
1121     /// ```
1122     /// // Iterate using a raw pointer in increments of two elements (backwards)
1123     /// let data = [1u8, 2, 3, 4, 5];
1124     /// let mut ptr: *const u8 = data.as_ptr();
1125     /// let start_rounded_down = ptr.wrapping_sub(2);
1126     /// ptr = ptr.wrapping_add(4);
1127     /// let step = 2;
1128     /// // This loop prints "5, 3, 1, "
1129     /// while ptr != start_rounded_down {
1130     ///     unsafe {
1131     ///         print!("{}, ", *ptr);
1132     ///     }
1133     ///     ptr = ptr.wrapping_sub(step);
1134     /// }
1135     /// ```
1136     #[stable(feature = "pointer_methods", since = "1.26.0")]
1137     #[must_use = "returns a new pointer rather than modifying its argument"]
1138     #[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
1139     #[inline]
1140     pub const fn wrapping_sub(self, count: usize) -> Self
1141     where
1142         T: Sized,
1143     {
1144         self.wrapping_offset((count as isize).wrapping_neg())
1145     }
1146
1147     /// Calculates the offset from a pointer in bytes using wrapping arithmetic.
1148     /// (convenience for `.wrapping_offset((count as isize).wrapping_neg())`)
1149     ///
1150     /// `count` is in units of bytes.
1151     ///
1152     /// This is purely a convenience for casting to a `u8` pointer and
1153     /// using [wrapping_sub][pointer::wrapping_sub] on it. See that method for documentation.
1154     ///
1155     /// For non-`Sized` pointees this operation changes only the data pointer,
1156     /// leaving the metadata untouched.
1157     #[must_use]
1158     #[inline(always)]
1159     #[unstable(feature = "pointer_byte_offsets", issue = "96283")]
1160     #[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
1161     pub const fn wrapping_byte_sub(self, count: usize) -> Self {
1162         from_raw_parts::<T>(self.cast::<u8>().wrapping_sub(count).cast::<()>(), metadata(self))
1163     }
1164
1165     /// Reads the value from `self` without moving it. This leaves the
1166     /// memory in `self` unchanged.
1167     ///
1168     /// See [`ptr::read`] for safety concerns and examples.
1169     ///
1170     /// [`ptr::read`]: crate::ptr::read()
1171     #[stable(feature = "pointer_methods", since = "1.26.0")]
1172     #[rustc_const_unstable(feature = "const_ptr_read", issue = "80377")]
1173     #[inline]
1174     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
1175     pub const unsafe fn read(self) -> T
1176     where
1177         T: Sized,
1178     {
1179         // SAFETY: the caller must uphold the safety contract for `read`.
1180         unsafe { read(self) }
1181     }
1182
1183     /// Performs a volatile read of the value from `self` without moving it. This
1184     /// leaves the memory in `self` unchanged.
1185     ///
1186     /// Volatile operations are intended to act on I/O memory, and are guaranteed
1187     /// to not be elided or reordered by the compiler across other volatile
1188     /// operations.
1189     ///
1190     /// See [`ptr::read_volatile`] for safety concerns and examples.
1191     ///
1192     /// [`ptr::read_volatile`]: crate::ptr::read_volatile()
1193     #[stable(feature = "pointer_methods", since = "1.26.0")]
1194     #[inline]
1195     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
1196     pub unsafe fn read_volatile(self) -> T
1197     where
1198         T: Sized,
1199     {
1200         // SAFETY: the caller must uphold the safety contract for `read_volatile`.
1201         unsafe { read_volatile(self) }
1202     }
1203
1204     /// Reads the value from `self` without moving it. This leaves the
1205     /// memory in `self` unchanged.
1206     ///
1207     /// Unlike `read`, the pointer may be unaligned.
1208     ///
1209     /// See [`ptr::read_unaligned`] for safety concerns and examples.
1210     ///
1211     /// [`ptr::read_unaligned`]: crate::ptr::read_unaligned()
1212     #[stable(feature = "pointer_methods", since = "1.26.0")]
1213     #[rustc_const_unstable(feature = "const_ptr_read", issue = "80377")]
1214     #[inline]
1215     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
1216     pub const unsafe fn read_unaligned(self) -> T
1217     where
1218         T: Sized,
1219     {
1220         // SAFETY: the caller must uphold the safety contract for `read_unaligned`.
1221         unsafe { read_unaligned(self) }
1222     }
1223
1224     /// Copies `count * size_of<T>` bytes from `self` to `dest`. The source
1225     /// and destination may overlap.
1226     ///
1227     /// NOTE: this has the *same* argument order as [`ptr::copy`].
1228     ///
1229     /// See [`ptr::copy`] for safety concerns and examples.
1230     ///
1231     /// [`ptr::copy`]: crate::ptr::copy()
1232     #[rustc_const_stable(feature = "const_intrinsic_copy", since = "1.63.0")]
1233     #[stable(feature = "pointer_methods", since = "1.26.0")]
1234     #[inline]
1235     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
1236     pub const unsafe fn copy_to(self, dest: *mut T, count: usize)
1237     where
1238         T: Sized,
1239     {
1240         // SAFETY: the caller must uphold the safety contract for `copy`.
1241         unsafe { copy(self, dest, count) }
1242     }
1243
1244     /// Copies `count * size_of<T>` bytes from `self` to `dest`. The source
1245     /// and destination may *not* overlap.
1246     ///
1247     /// NOTE: this has the *same* argument order as [`ptr::copy_nonoverlapping`].
1248     ///
1249     /// See [`ptr::copy_nonoverlapping`] for safety concerns and examples.
1250     ///
1251     /// [`ptr::copy_nonoverlapping`]: crate::ptr::copy_nonoverlapping()
1252     #[rustc_const_stable(feature = "const_intrinsic_copy", since = "1.63.0")]
1253     #[stable(feature = "pointer_methods", since = "1.26.0")]
1254     #[inline]
1255     #[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
1256     pub const unsafe fn copy_to_nonoverlapping(self, dest: *mut T, count: usize)
1257     where
1258         T: Sized,
1259     {
1260         // SAFETY: the caller must uphold the safety contract for `copy_nonoverlapping`.
1261         unsafe { copy_nonoverlapping(self, dest, count) }
1262     }
1263
1264     /// Computes the offset that needs to be applied to the pointer in order to make it aligned to
1265     /// `align`.
1266     ///
1267     /// If it is not possible to align the pointer, the implementation returns
1268     /// `usize::MAX`. It is permissible for the implementation to *always*
1269     /// return `usize::MAX`. Only your algorithm's performance can depend
1270     /// on getting a usable offset here, not its correctness.
1271     ///
1272     /// The offset is expressed in number of `T` elements, and not bytes. The value returned can be
1273     /// used with the `wrapping_add` method.
1274     ///
1275     /// There are no guarantees whatsoever that offsetting the pointer will not overflow or go
1276     /// beyond the allocation that the pointer points into. It is up to the caller to ensure that
1277     /// the returned offset is correct in all terms other than alignment.
1278     ///
1279     /// # Panics
1280     ///
1281     /// The function panics if `align` is not a power-of-two.
1282     ///
1283     /// # Examples
1284     ///
1285     /// Accessing adjacent `u8` as `u16`
1286     ///
1287     /// ```
1288     /// use std::mem::align_of;
1289     ///
1290     /// # unsafe {
1291     /// let x = [5_u8, 6, 7, 8, 9];
1292     /// let ptr = x.as_ptr();
1293     /// let offset = ptr.align_offset(align_of::<u16>());
1294     ///
1295     /// if offset < x.len() - 1 {
1296     ///     let u16_ptr = ptr.add(offset).cast::<u16>();
1297     ///     assert!(*u16_ptr == u16::from_ne_bytes([5, 6]) || *u16_ptr == u16::from_ne_bytes([6, 7]));
1298     /// } else {
1299     ///     // while the pointer can be aligned via `offset`, it would point
1300     ///     // outside the allocation
1301     /// }
1302     /// # }
1303     /// ```
1304     #[stable(feature = "align_offset", since = "1.36.0")]
1305     #[rustc_const_unstable(feature = "const_align_offset", issue = "90962")]
1306     pub const fn align_offset(self, align: usize) -> usize
1307     where
1308         T: Sized,
1309     {
1310         if !align.is_power_of_two() {
1311             panic!("align_offset: align is not a power-of-two");
1312         }
1313
1314         fn rt_impl<T>(p: *const T, align: usize) -> usize {
1315             // SAFETY: `align` has been checked to be a power of 2 above
1316             unsafe { align_offset(p, align) }
1317         }
1318
1319         const fn ctfe_impl<T>(_: *const T, _: usize) -> usize {
1320             usize::MAX
1321         }
1322
1323         // SAFETY:
1324         // It is permissible for `align_offset` to always return `usize::MAX`,
1325         // algorithm correctness can not depend on `align_offset` returning non-max values.
1326         //
1327         // As such the behaviour can't change after replacing `align_offset` with `usize::MAX`, only performance can.
1328         unsafe { intrinsics::const_eval_select((self, align), ctfe_impl, rt_impl) }
1329     }
1330
1331     /// Returns whether the pointer is properly aligned for `T`.
1332     #[must_use]
1333     #[inline]
1334     #[unstable(feature = "pointer_is_aligned", issue = "96284")]
1335     pub fn is_aligned(self) -> bool
1336     where
1337         T: Sized,
1338     {
1339         self.is_aligned_to(core::mem::align_of::<T>())
1340     }
1341
1342     /// Returns whether the pointer is aligned to `align`.
1343     ///
1344     /// For non-`Sized` pointees this operation considers only the data pointer,
1345     /// ignoring the metadata.
1346     ///
1347     /// # Panics
1348     ///
1349     /// The function panics if `align` is not a power-of-two (this includes 0).
1350     #[must_use]
1351     #[inline]
1352     #[unstable(feature = "pointer_is_aligned", issue = "96284")]
1353     pub fn is_aligned_to(self, align: usize) -> bool {
1354         if !align.is_power_of_two() {
1355             panic!("is_aligned_to: align is not a power-of-two");
1356         }
1357
1358         // Cast is needed for `T: !Sized`
1359         self.cast::<u8>().addr() & align - 1 == 0
1360     }
1361 }
1362
1363 impl<T> *const [T] {
1364     /// Returns the length of a raw slice.
1365     ///
1366     /// The returned value is the number of **elements**, not the number of bytes.
1367     ///
1368     /// This function is safe, even when the raw slice cannot be cast to a slice
1369     /// reference because the pointer is null or unaligned.
1370     ///
1371     /// # Examples
1372     ///
1373     /// ```rust
1374     /// #![feature(slice_ptr_len)]
1375     ///
1376     /// use std::ptr;
1377     ///
1378     /// let slice: *const [i8] = ptr::slice_from_raw_parts(ptr::null(), 3);
1379     /// assert_eq!(slice.len(), 3);
1380     /// ```
1381     #[inline]
1382     #[unstable(feature = "slice_ptr_len", issue = "71146")]
1383     #[rustc_const_unstable(feature = "const_slice_ptr_len", issue = "71146")]
1384     pub const fn len(self) -> usize {
1385         metadata(self)
1386     }
1387
1388     /// Returns a raw pointer to the slice's buffer.
1389     ///
1390     /// This is equivalent to casting `self` to `*const T`, but more type-safe.
1391     ///
1392     /// # Examples
1393     ///
1394     /// ```rust
1395     /// #![feature(slice_ptr_get)]
1396     /// use std::ptr;
1397     ///
1398     /// let slice: *const [i8] = ptr::slice_from_raw_parts(ptr::null(), 3);
1399     /// assert_eq!(slice.as_ptr(), ptr::null());
1400     /// ```
1401     #[inline]
1402     #[unstable(feature = "slice_ptr_get", issue = "74265")]
1403     #[rustc_const_unstable(feature = "slice_ptr_get", issue = "74265")]
1404     pub const fn as_ptr(self) -> *const T {
1405         self as *const T
1406     }
1407
1408     /// Returns a raw pointer to an element or subslice, without doing bounds
1409     /// checking.
1410     ///
1411     /// Calling this method with an out-of-bounds index or when `self` is not dereferenceable
1412     /// is *[undefined behavior]* even if the resulting pointer is not used.
1413     ///
1414     /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1415     ///
1416     /// # Examples
1417     ///
1418     /// ```
1419     /// #![feature(slice_ptr_get)]
1420     ///
1421     /// let x = &[1, 2, 4] as *const [i32];
1422     ///
1423     /// unsafe {
1424     ///     assert_eq!(x.get_unchecked(1), x.as_ptr().add(1));
1425     /// }
1426     /// ```
1427     #[unstable(feature = "slice_ptr_get", issue = "74265")]
1428     #[rustc_const_unstable(feature = "const_slice_index", issue = "none")]
1429     #[inline]
1430     pub const unsafe fn get_unchecked<I>(self, index: I) -> *const I::Output
1431     where
1432         I: ~const SliceIndex<[T]>,
1433     {
1434         // SAFETY: the caller ensures that `self` is dereferenceable and `index` in-bounds.
1435         unsafe { index.get_unchecked(self) }
1436     }
1437
1438     /// Returns `None` if the pointer is null, or else returns a shared slice to
1439     /// the value wrapped in `Some`. In contrast to [`as_ref`], this does not require
1440     /// that the value has to be initialized.
1441     ///
1442     /// [`as_ref`]: #method.as_ref
1443     ///
1444     /// # Safety
1445     ///
1446     /// When calling this method, you have to ensure that *either* the pointer is null *or*
1447     /// all of the following is true:
1448     ///
1449     /// * The pointer must be [valid] for reads for `ptr.len() * mem::size_of::<T>()` many bytes,
1450     ///   and it must be properly aligned. This means in particular:
1451     ///
1452     ///     * The entire memory range of this slice must be contained within a single [allocated object]!
1453     ///       Slices can never span across multiple allocated objects.
1454     ///
1455     ///     * The pointer must be aligned even for zero-length slices. One
1456     ///       reason for this is that enum layout optimizations may rely on references
1457     ///       (including slices of any length) being aligned and non-null to distinguish
1458     ///       them from other data. You can obtain a pointer that is usable as `data`
1459     ///       for zero-length slices using [`NonNull::dangling()`].
1460     ///
1461     /// * The total size `ptr.len() * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
1462     ///   See the safety documentation of [`pointer::offset`].
1463     ///
1464     /// * You must enforce Rust's aliasing rules, since the returned lifetime `'a` is
1465     ///   arbitrarily chosen and does not necessarily reflect the actual lifetime of the data.
1466     ///   In particular, while this reference exists, the memory the pointer points to must
1467     ///   not get mutated (except inside `UnsafeCell`).
1468     ///
1469     /// This applies even if the result of this method is unused!
1470     ///
1471     /// See also [`slice::from_raw_parts`][].
1472     ///
1473     /// [valid]: crate::ptr#safety
1474     /// [allocated object]: crate::ptr#allocated-object
1475     #[inline]
1476     #[unstable(feature = "ptr_as_uninit", issue = "75402")]
1477     #[rustc_const_unstable(feature = "const_ptr_as_ref", issue = "91822")]
1478     pub const unsafe fn as_uninit_slice<'a>(self) -> Option<&'a [MaybeUninit<T>]> {
1479         if self.is_null() {
1480             None
1481         } else {
1482             // SAFETY: the caller must uphold the safety contract for `as_uninit_slice`.
1483             Some(unsafe { slice::from_raw_parts(self as *const MaybeUninit<T>, self.len()) })
1484         }
1485     }
1486 }
1487
1488 // Equality for pointers
1489 #[stable(feature = "rust1", since = "1.0.0")]
1490 impl<T: ?Sized> PartialEq for *const T {
1491     #[inline]
1492     fn eq(&self, other: &*const T) -> bool {
1493         *self == *other
1494     }
1495 }
1496
1497 #[stable(feature = "rust1", since = "1.0.0")]
1498 impl<T: ?Sized> Eq for *const T {}
1499
1500 // Comparison for pointers
1501 #[stable(feature = "rust1", since = "1.0.0")]
1502 impl<T: ?Sized> Ord for *const T {
1503     #[inline]
1504     fn cmp(&self, other: &*const T) -> Ordering {
1505         if self < other {
1506             Less
1507         } else if self == other {
1508             Equal
1509         } else {
1510             Greater
1511         }
1512     }
1513 }
1514
1515 #[stable(feature = "rust1", since = "1.0.0")]
1516 impl<T: ?Sized> PartialOrd for *const T {
1517     #[inline]
1518     fn partial_cmp(&self, other: &*const T) -> Option<Ordering> {
1519         Some(self.cmp(other))
1520     }
1521
1522     #[inline]
1523     fn lt(&self, other: &*const T) -> bool {
1524         *self < *other
1525     }
1526
1527     #[inline]
1528     fn le(&self, other: &*const T) -> bool {
1529         *self <= *other
1530     }
1531
1532     #[inline]
1533     fn gt(&self, other: &*const T) -> bool {
1534         *self > *other
1535     }
1536
1537     #[inline]
1538     fn ge(&self, other: &*const T) -> bool {
1539         *self >= *other
1540     }
1541 }