src/liballoc/raw_vec.rs

   1 #![unstable(feature = "raw_vec_internals", reason = "implementation detail", issue = "none")]
   2 #![doc(hidden)]
   3
   4 use core::alloc::MemoryBlock;
   5 use core::cmp;
   6 use core::mem::{self, ManuallyDrop, MaybeUninit};
   7 use core::ops::Drop;
   8 use core::ptr::{NonNull, Unique};
   9 use core::slice;
  10
  11 use crate::alloc::{
  12     handle_alloc_error, AllocErr,
  13     AllocInit::{self, *},
  14     AllocRef, Global, Layout,
  15     ReallocPlacement::{self, *},
  16 };
  17 use crate::boxed::Box;
  18 use crate::collections::TryReserveError::{self, *};
  19
  20 #[cfg(test)]
  21 mod tests;
  22
  23 /// A low-level utility for more ergonomically allocating, reallocating, and deallocating
  24 /// a buffer of memory on the heap without having to worry about all the corner cases
  25 /// involved. This type is excellent for building your own data structures like Vec and VecDeque.
  26 /// In particular:
  27 ///
  28 /// * Produces `Unique::dangling()` on zero-sized types.
  29 /// * Produces `Unique::dangling()` on zero-length allocations.
  30 /// * Avoids freeing `Unique::dangling()`.
  31 /// * Catches all overflows in capacity computations (promotes them to "capacity overflow" panics).
  32 /// * Guards against 32-bit systems allocating more than isize::MAX bytes.
  33 /// * Guards against overflowing your length.
  34 /// * Calls `handle_alloc_error` for fallible allocations.
  35 /// * Contains a `ptr::Unique` and thus endows the user with all related benefits.
  36 /// * Uses the excess returned from the allocator to use the largest available capacity.
  37 ///
  38 /// This type does not in anyway inspect the memory that it manages. When dropped it *will*
  39 /// free its memory, but it *won't* try to drop its contents. It is up to the user of `RawVec`
  40 /// to handle the actual things *stored* inside of a `RawVec`.
  41 ///
  42 /// Note that the excess of a zero-sized types is always infinite, so `capacity()` always returns
  43 /// `usize::MAX`. This means that you need to be careful when round-tripping this type with a
  44 /// `Box<[T]>`, since `capacity()` won't yield the length.
  45 #[allow(missing_debug_implementations)]
  46 pub struct RawVec<T, A: AllocRef = Global> {
  47     ptr: Unique<T>,
  48     cap: usize,
  49     alloc: A,
  50 }
  51
  52 impl<T> RawVec<T, Global> {
  53     /// HACK(Centril): This exists because `#[unstable]` `const fn`s needn't conform
  54     /// to `min_const_fn` and so they cannot be called in `min_const_fn`s either.
  55     ///
  56     /// If you change `RawVec<T>::new` or dependencies, please take care to not
  57     /// introduce anything that would truly violate `min_const_fn`.
  58     ///
  59     /// NOTE: We could avoid this hack and check conformance with some
  60     /// `#[rustc_force_min_const_fn]` attribute which requires conformance
  61     /// with `min_const_fn` but does not necessarily allow calling it in
  62     /// `stable(...) const fn` / user code not enabling `foo` when
  63     /// `#[rustc_const_unstable(feature = "foo", ..)]` is present.
  64     pub const NEW: Self = Self::new();
  65
  66     /// Creates the biggest possible `RawVec` (on the system heap)
  67     /// without allocating. If `T` has positive size, then this makes a
  68     /// `RawVec` with capacity `0`. If `T` is zero-sized, then it makes a
  69     /// `RawVec` with capacity `usize::MAX`. Useful for implementing
  70     /// delayed allocation.
  71     pub const fn new() -> Self {
  72         Self::new_in(Global)
  73     }
  74
  75     /// Creates a `RawVec` (on the system heap) with exactly the
  76     /// capacity and alignment requirements for a `[T; capacity]`. This is
  77     /// equivalent to calling `RawVec::new` when `capacity` is `0` or `T` is
  78     /// zero-sized. Note that if `T` is zero-sized this means you will
  79     /// *not* get a `RawVec` with the requested capacity.
  80     ///
  81     /// # Panics
  82     ///
  83     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
  84     /// * Panics on 32-bit platforms if the requested capacity exceeds
  85     ///   `isize::MAX` bytes.
  86     ///
  87     /// # Aborts
  88     ///
  89     /// Aborts on OOM.
  90     #[inline]
  91     pub fn with_capacity(capacity: usize) -> Self {
  92         Self::with_capacity_in(capacity, Global)
  93     }
  94
  95     /// Like `with_capacity`, but guarantees the buffer is zeroed.
  96     #[inline]
  97     pub fn with_capacity_zeroed(capacity: usize) -> Self {
  98         Self::with_capacity_zeroed_in(capacity, Global)
  99     }
 100
 101     /// Reconstitutes a `RawVec` from a pointer and capacity.
 102     ///
 103     /// # Safety
 104     ///
 105     /// The `ptr` must be allocated (on the system heap), and with the given `capacity`.
 106     /// The `capacity` cannot exceed `isize::MAX` for sized types. (only a concern on 32-bit
 107     /// systems). ZST vectors may have a capacity up to `usize::MAX`.
 108     /// If the `ptr` and `capacity` come from a `RawVec`, then this is guaranteed.
 109     #[inline]
 110     pub unsafe fn from_raw_parts(ptr: *mut T, capacity: usize) -> Self {
 111         Self::from_raw_parts_in(ptr, capacity, Global)
 112     }
 113
 114     /// Converts a `Box<[T]>` into a `RawVec<T>`.
 115     pub fn from_box(slice: Box<[T]>) -> Self {
 116         unsafe {
 117             let mut slice = ManuallyDrop::new(slice);
 118             RawVec::from_raw_parts(slice.as_mut_ptr(), slice.len())
 119         }
 120     }
 121 }
 122
 123 impl<T, A: AllocRef> RawVec<T, A> {
 124     /// Like `new`, but parameterized over the choice of allocator for
 125     /// the returned `RawVec`.
 126     pub const fn new_in(alloc: A) -> Self {
 127         // `cap: 0` means "unallocated". zero-sized types are ignored.
 128         Self { ptr: Unique::dangling(), cap: 0, alloc }
 129     }
 130
 131     /// Like `with_capacity`, but parameterized over the choice of
 132     /// allocator for the returned `RawVec`.
 133     #[inline]
 134     pub fn with_capacity_in(capacity: usize, alloc: A) -> Self {
 135         Self::allocate_in(capacity, Uninitialized, alloc)
 136     }
 137
 138     /// Like `with_capacity_zeroed`, but parameterized over the choice
 139     /// of allocator for the returned `RawVec`.
 140     #[inline]
 141     pub fn with_capacity_zeroed_in(capacity: usize, alloc: A) -> Self {
 142         Self::allocate_in(capacity, Zeroed, alloc)
 143     }
 144
 145     fn allocate_in(capacity: usize, init: AllocInit, mut alloc: A) -> Self {
 146         if mem::size_of::<T>() == 0 {
 147             Self::new_in(alloc)
 148         } else {
 149             let layout = Layout::array::<T>(capacity).unwrap_or_else(|_| capacity_overflow());
 150             alloc_guard(layout.size()).unwrap_or_else(|_| capacity_overflow());
 151
 152             let memory = alloc.alloc(layout, init).unwrap_or_else(|_| handle_alloc_error(layout));
 153             Self {
 154                 ptr: unsafe { Unique::new_unchecked(memory.ptr.cast().as_ptr()) },
 155                 cap: Self::capacity_from_bytes(memory.size),
 156                 alloc,
 157             }
 158         }
 159     }
 160
 161     /// Reconstitutes a `RawVec` from a pointer, capacity, and allocator.
 162     ///
 163     /// # Safety
 164     ///
 165     /// The `ptr` must be allocated (via the given allocator `a`), and with the given `capacity`.
 166     /// The `capacity` cannot exceed `isize::MAX` for sized types. (only a concern on 32-bit
 167     /// systems). ZST vectors may have a capacity up to `usize::MAX`.
 168     /// If the `ptr` and `capacity` come from a `RawVec` created via `a`, then this is guaranteed.
 169     #[inline]
 170     pub unsafe fn from_raw_parts_in(ptr: *mut T, capacity: usize, a: A) -> Self {
 171         Self { ptr: Unique::new_unchecked(ptr), cap: capacity, alloc: a }
 172     }
 173
 174     /// Gets a raw pointer to the start of the allocation. Note that this is
 175     /// `Unique::dangling()` if `capacity == 0` or `T` is zero-sized. In the former case, you must
 176     /// be careful.
 177     pub fn ptr(&self) -> *mut T {
 178         self.ptr.as_ptr()
 179     }
 180
 181     /// Gets the capacity of the allocation.
 182     ///
 183     /// This will always be `usize::MAX` if `T` is zero-sized.
 184     #[inline(always)]
 185     pub fn capacity(&self) -> usize {
 186         if mem::size_of::<T>() == 0 { usize::MAX } else { self.cap }
 187     }
 188
 189     /// Returns a shared reference to the allocator backing this `RawVec`.
 190     pub fn alloc(&self) -> &A {
 191         &self.alloc
 192     }
 193
 194     /// Returns a mutable reference to the allocator backing this `RawVec`.
 195     pub fn alloc_mut(&mut self) -> &mut A {
 196         &mut self.alloc
 197     }
 198
 199     fn current_memory(&self) -> Option<(NonNull<u8>, Layout)> {
 200         if mem::size_of::<T>() == 0 || self.cap == 0 {
 201             None
 202         } else {
 203             // We have an allocated chunk of memory, so we can bypass runtime
 204             // checks to get our current layout.
 205             unsafe {
 206                 let align = mem::align_of::<T>();
 207                 let size = mem::size_of::<T>() * self.cap;
 208                 let layout = Layout::from_size_align_unchecked(size, align);
 209                 Some((self.ptr.cast().into(), layout))
 210             }
 211         }
 212     }
 213
 214     /// Doubles the size of the type's backing allocation. This is common enough
 215     /// to want to do that it's easiest to just have a dedicated method. Slightly
 216     /// more efficient logic can be provided for this than the general case.
 217     ///
 218     /// This function is ideal for when pushing elements one-at-a-time because
 219     /// you don't need to incur the costs of the more general computations
 220     /// reserve needs to do to guard against overflow. You do however need to
 221     /// manually check if your `len == capacity`.
 222     ///
 223     /// # Panics
 224     ///
 225     /// * Panics if `T` is zero-sized on the assumption that you managed to exhaust
 226     ///   all `usize::MAX` slots in your imaginary buffer.
 227     /// * Panics on 32-bit platforms if the requested capacity exceeds
 228     ///   `isize::MAX` bytes.
 229     ///
 230     /// # Aborts
 231     ///
 232     /// Aborts on OOM
 233     ///
 234     /// # Examples
 235     ///
 236     /// ```
 237     /// # #![feature(raw_vec_internals)]
 238     /// # extern crate alloc;
 239     /// # use std::ptr;
 240     /// # use alloc::raw_vec::RawVec;
 241     /// struct MyVec<T> {
 242     ///     buf: RawVec<T>,
 243     ///     len: usize,
 244     /// }
 245     ///
 246     /// impl<T> MyVec<T> {
 247     ///     pub fn push(&mut self, elem: T) {
 248     ///         if self.len == self.buf.capacity() { self.buf.double(); }
 249     ///         // double would have aborted or panicked if the len exceeded
 250     ///         // `isize::MAX` so this is safe to do unchecked now.
 251     ///         unsafe {
 252     ///             ptr::write(self.buf.ptr().add(self.len), elem);
 253     ///         }
 254     ///         self.len += 1;
 255     ///     }
 256     /// }
 257     /// # fn main() {
 258     /// #   let mut vec = MyVec { buf: RawVec::new(), len: 0 };
 259     /// #   vec.push(1);
 260     /// # }
 261     /// ```
 262     #[inline(never)]
 263     #[cold]
 264     pub fn double(&mut self) {
 265         match self.grow(Double, MayMove, Uninitialized) {
 266             Err(CapacityOverflow) => capacity_overflow(),
 267             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 268             Ok(()) => { /* yay */ }
 269         }
 270     }
 271
 272     /// Ensures that the buffer contains at least enough space to hold
 273     /// `used_capacity + needed_extra_capacity` elements. If it doesn't already have
 274     /// enough capacity, will reallocate enough space plus comfortable slack
 275     /// space to get amortized `O(1)` behavior. Will limit this behavior
 276     /// if it would needlessly cause itself to panic.
 277     ///
 278     /// If `used_capacity` exceeds `self.capacity()`, this may fail to actually allocate
 279     /// the requested space. This is not really unsafe, but the unsafe
 280     /// code *you* write that relies on the behavior of this function may break.
 281     ///
 282     /// This is ideal for implementing a bulk-push operation like `extend`.
 283     ///
 284     /// # Panics
 285     ///
 286     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
 287     /// * Panics on 32-bit platforms if the requested capacity exceeds
 288     ///   `isize::MAX` bytes.
 289     ///
 290     /// # Aborts
 291     ///
 292     /// Aborts on OOM.
 293     ///
 294     /// # Examples
 295     ///
 296     /// ```
 297     /// # #![feature(raw_vec_internals)]
 298     /// # extern crate alloc;
 299     /// # use std::ptr;
 300     /// # use alloc::raw_vec::RawVec;
 301     /// struct MyVec<T> {
 302     ///     buf: RawVec<T>,
 303     ///     len: usize,
 304     /// }
 305     ///
 306     /// impl<T: Clone> MyVec<T> {
 307     ///     pub fn push_all(&mut self, elems: &[T]) {
 308     ///         self.buf.reserve(self.len, elems.len());
 309     ///         // reserve would have aborted or panicked if the len exceeded
 310     ///         // `isize::MAX` so this is safe to do unchecked now.
 311     ///         for x in elems {
 312     ///             unsafe {
 313     ///                 ptr::write(self.buf.ptr().add(self.len), x.clone());
 314     ///             }
 315     ///             self.len += 1;
 316     ///         }
 317     ///     }
 318     /// }
 319     /// # fn main() {
 320     /// #   let mut vector = MyVec { buf: RawVec::new(), len: 0 };
 321     /// #   vector.push_all(&[1, 3, 5, 7, 9]);
 322     /// # }
 323     /// ```
 324     pub fn reserve(&mut self, used_capacity: usize, needed_extra_capacity: usize) {
 325         match self.try_reserve(used_capacity, needed_extra_capacity) {
 326             Err(CapacityOverflow) => capacity_overflow(),
 327             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 328             Ok(()) => { /* yay */ }
 329         }
 330     }
 331
 332     /// The same as `reserve`, but returns on errors instead of panicking or aborting.
 333     pub fn try_reserve(
 334         &mut self,
 335         used_capacity: usize,
 336         needed_extra_capacity: usize,
 337     ) -> Result<(), TryReserveError> {
 338         if self.needs_to_grow(used_capacity, needed_extra_capacity) {
 339             self.grow(Amortized { used_capacity, needed_extra_capacity }, MayMove, Uninitialized)
 340         } else {
 341             Ok(())
 342         }
 343     }
 344
 345     /// Attempts to ensure that the buffer contains at least enough space to hold
 346     /// `used_capacity + needed_extra_capacity` elements. If it doesn't already have
 347     /// enough capacity, will reallocate in place enough space plus comfortable slack
 348     /// space to get amortized `O(1)` behavior. Will limit this behaviour
 349     /// if it would needlessly cause itself to panic.
 350     ///
 351     /// If `used_capacity` exceeds `self.capacity()`, this may fail to actually allocate
 352     /// the requested space. This is not really unsafe, but the unsafe
 353     /// code *you* write that relies on the behavior of this function may break.
 354     ///
 355     /// Returns `true` if the reallocation attempt has succeeded.
 356     ///
 357     /// # Panics
 358     ///
 359     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
 360     /// * Panics on 32-bit platforms if the requested capacity exceeds
 361     ///   `isize::MAX` bytes.
 362     pub fn reserve_in_place(&mut self, used_capacity: usize, needed_extra_capacity: usize) -> bool {
 363         // This is more readable than putting this in one line:
 364         // `!self.needs_to_grow(...) || self.grow(...).is_ok()`
 365         if self.needs_to_grow(used_capacity, needed_extra_capacity) {
 366             self.grow(Amortized { used_capacity, needed_extra_capacity }, InPlace, Uninitialized)
 367                 .is_ok()
 368         } else {
 369             true
 370         }
 371     }
 372
 373     /// Ensures that the buffer contains at least enough space to hold
 374     /// `used_capacity + needed_extra_capacity` elements. If it doesn't already,
 375     /// will reallocate the minimum possible amount of memory necessary.
 376     /// Generally this will be exactly the amount of memory necessary,
 377     /// but in principle the allocator is free to give back more than
 378     /// we asked for.
 379     ///
 380     /// If `used_capacity` exceeds `self.capacity()`, this may fail to actually allocate
 381     /// the requested space. This is not really unsafe, but the unsafe
 382     /// code *you* write that relies on the behavior of this function may break.
 383     ///
 384     /// # Panics
 385     ///
 386     /// * Panics if the requested capacity exceeds `usize::MAX` bytes.
 387     /// * Panics on 32-bit platforms if the requested capacity exceeds
 388     ///   `isize::MAX` bytes.
 389     ///
 390     /// # Aborts
 391     ///
 392     /// Aborts on OOM.
 393     pub fn reserve_exact(&mut self, used_capacity: usize, needed_extra_capacity: usize) {
 394         match self.try_reserve_exact(used_capacity, needed_extra_capacity) {
 395             Err(CapacityOverflow) => capacity_overflow(),
 396             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 397             Ok(()) => { /* yay */ }
 398         }
 399     }
 400
 401     /// The same as `reserve_exact`, but returns on errors instead of panicking or aborting.
 402     pub fn try_reserve_exact(
 403         &mut self,
 404         used_capacity: usize,
 405         needed_extra_capacity: usize,
 406     ) -> Result<(), TryReserveError> {
 407         if self.needs_to_grow(used_capacity, needed_extra_capacity) {
 408             self.grow(Exact { used_capacity, needed_extra_capacity }, MayMove, Uninitialized)
 409         } else {
 410             Ok(())
 411         }
 412     }
 413
 414     /// Shrinks the allocation down to the specified amount. If the given amount
 415     /// is 0, actually completely deallocates.
 416     ///
 417     /// # Panics
 418     ///
 419     /// Panics if the given amount is *larger* than the current capacity.
 420     ///
 421     /// # Aborts
 422     ///
 423     /// Aborts on OOM.
 424     pub fn shrink_to_fit(&mut self, amount: usize) {
 425         match self.shrink(amount, MayMove) {
 426             Err(CapacityOverflow) => capacity_overflow(),
 427             Err(AllocError { layout, .. }) => handle_alloc_error(layout),
 428             Ok(()) => { /* yay */ }
 429         }
 430     }
 431 }
 432
 433 #[derive(Copy, Clone)]
 434 enum Strategy {
 435     Double,
 436     Amortized { used_capacity: usize, needed_extra_capacity: usize },
 437     Exact { used_capacity: usize, needed_extra_capacity: usize },
 438 }
 439 use Strategy::*;
 440
 441 impl<T, A: AllocRef> RawVec<T, A> {
 442     /// Returns if the buffer needs to grow to fulfill the needed extra capacity.
 443     /// Mainly used to make inlining reserve-calls possible without inlining `grow`.
 444     fn needs_to_grow(&self, used_capacity: usize, needed_extra_capacity: usize) -> bool {
 445         needed_extra_capacity > self.capacity().wrapping_sub(used_capacity)
 446     }
 447
 448     fn capacity_from_bytes(excess: usize) -> usize {
 449         debug_assert_ne!(mem::size_of::<T>(), 0);
 450         excess / mem::size_of::<T>()
 451     }
 452
 453     fn set_memory(&mut self, memory: MemoryBlock) {
 454         self.ptr = unsafe { Unique::new_unchecked(memory.ptr.cast().as_ptr()) };
 455         self.cap = Self::capacity_from_bytes(memory.size);
 456     }
 457
 458     /// Single method to handle all possibilities of growing the buffer.
 459     fn grow(
 460         &mut self,
 461         strategy: Strategy,
 462         placement: ReallocPlacement,
 463         init: AllocInit,
 464     ) -> Result<(), TryReserveError> {
 465         let elem_size = mem::size_of::<T>();
 466         if elem_size == 0 {
 467             // Since we return a capacity of `usize::MAX` when `elem_size` is
 468             // 0, getting to here necessarily means the `RawVec` is overfull.
 469             return Err(CapacityOverflow);
 470         }
 471         let new_layout = match strategy {
 472             Double => unsafe {
 473                 // Since we guarantee that we never allocate more than `isize::MAX` bytes,
 474                 // `elem_size * self.cap <= isize::MAX` as a precondition, so this can't overflow.
 475                 // Additionally the alignment will never be too large as to "not be satisfiable",
 476                 // so `Layout::from_size_align` will always return `Some`.
 477                 //
 478                 // TL;DR, we bypass runtime checks due to dynamic assertions in this module,
 479                 // allowing us to use `from_size_align_unchecked`.
 480                 let cap = if self.cap == 0 {
 481                     // Skip to 4 because tiny `Vec`'s are dumb; but not if that would cause overflow.
 482                     if elem_size > usize::MAX / 8 { 1 } else { 4 }
 483                 } else {
 484                     self.cap * 2
 485                 };
 486                 Layout::from_size_align_unchecked(cap * elem_size, mem::align_of::<T>())
 487             },
 488             Amortized { used_capacity, needed_extra_capacity } => {
 489                 // Nothing we can really do about these checks, sadly.
 490                 let required_cap =
 491                     used_capacity.checked_add(needed_extra_capacity).ok_or(CapacityOverflow)?;
 492                 // Cannot overflow, because `cap <= isize::MAX`, and type of `cap` is `usize`.
 493                 let double_cap = self.cap * 2;
 494                 // `double_cap` guarantees exponential growth.
 495                 let cap = cmp::max(double_cap, required_cap);
 496                 Layout::array::<T>(cap).map_err(|_| CapacityOverflow)?
 497             }
 498             Exact { used_capacity, needed_extra_capacity } => {
 499                 let cap =
 500                     used_capacity.checked_add(needed_extra_capacity).ok_or(CapacityOverflow)?;
 501                 Layout::array::<T>(cap).map_err(|_| CapacityOverflow)?
 502             }
 503         };
 504         alloc_guard(new_layout.size())?;
 505
 506         let memory = if let Some((ptr, old_layout)) = self.current_memory() {
 507             debug_assert_eq!(old_layout.align(), new_layout.align());
 508             unsafe {
 509                 self.alloc
 510                     .grow(ptr, old_layout, new_layout.size(), placement, init)
 511                     .map_err(|_| AllocError { layout: new_layout, non_exhaustive: () })?
 512             }
 513         } else {
 514             match placement {
 515                 MayMove => self.alloc.alloc(new_layout, init),
 516                 InPlace => Err(AllocErr),
 517             }
 518             .map_err(|_| AllocError { layout: new_layout, non_exhaustive: () })?
 519         };
 520         self.set_memory(memory);
 521         Ok(())
 522     }
 523
 524     fn shrink(
 525         &mut self,
 526         amount: usize,
 527         placement: ReallocPlacement,
 528     ) -> Result<(), TryReserveError> {
 529         assert!(amount <= self.capacity(), "Tried to shrink to a larger capacity");
 530
 531         let (ptr, layout) = if let Some(mem) = self.current_memory() { mem } else { return Ok(()) };
 532         let new_size = amount * mem::size_of::<T>();
 533
 534         let memory = unsafe {
 535             self.alloc.shrink(ptr, layout, new_size, placement).map_err(|_| {
 536                 TryReserveError::AllocError {
 537                     layout: Layout::from_size_align_unchecked(new_size, layout.align()),
 538                     non_exhaustive: (),
 539                 }
 540             })?
 541         };
 542         self.set_memory(memory);
 543         Ok(())
 544     }
 545 }
 546
 547 impl<T> RawVec<T, Global> {
 548     /// Converts the entire buffer into `Box<[MaybeUninit<T>]>` with the specified `len`.
 549     ///
 550     /// Note that this will correctly reconstitute any `cap` changes
 551     /// that may have been performed. (See description of type for details.)
 552     ///
 553     /// # Safety
 554     ///
 555     /// * `len` must be greater than or equal to the most recently requested capacity, and
 556     /// * `len` must be less than or equal to `self.capacity()`.
 557     ///
 558     /// Note, that the requested capacity and `self.capacity()` could differ, as
 559     /// an allocator could overallocate and return a greater memory block than requested.
 560     pub unsafe fn into_box(self, len: usize) -> Box<[MaybeUninit<T>]> {
 561         // Sanity-check one half of the safety requirement (we cannot check the other half).
 562         debug_assert!(
 563             len <= self.capacity(),
 564             "`len` must be smaller than or equal to `self.capacity()`"
 565         );
 566
 567         let me = ManuallyDrop::new(self);
 568         let slice = slice::from_raw_parts_mut(me.ptr() as *mut MaybeUninit<T>, len);
 569         Box::from_raw(slice)
 570     }
 571 }
 572
 573 unsafe impl<#[may_dangle] T, A: AllocRef> Drop for RawVec<T, A> {
 574     /// Frees the memory owned by the `RawVec` *without* trying to drop its contents.
 575     fn drop(&mut self) {
 576         if let Some((ptr, layout)) = self.current_memory() {
 577             unsafe { self.alloc.dealloc(ptr, layout) }
 578         }
 579     }
 580 }
 581
 582 // We need to guarantee the following:
 583 // * We don't ever allocate `> isize::MAX` byte-size objects.
 584 // * We don't overflow `usize::MAX` and actually allocate too little.
 585 //
 586 // On 64-bit we just need to check for overflow since trying to allocate
 587 // `> isize::MAX` bytes will surely fail. On 32-bit and 16-bit we need to add
 588 // an extra guard for this in case we're running on a platform which can use
 589 // all 4GB in user-space, e.g., PAE or x32.
 590
 591 #[inline]
 592 fn alloc_guard(alloc_size: usize) -> Result<(), TryReserveError> {
 593     if mem::size_of::<usize>() < 8 && alloc_size > isize::MAX as usize {
 594         Err(CapacityOverflow)
 595     } else {
 596         Ok(())
 597     }
 598 }
 599
 600 // One central function responsible for reporting capacity overflows. This'll
 601 // ensure that the code generation related to these panics is minimal as there's
 602 // only one location which panics rather than a bunch throughout the module.
 603 fn capacity_overflow() -> ! {
 604     panic!("capacity overflow");
 605 }