bump-scope 2.3.0

A fast bump allocator that supports allocation scopes / checkpoints. Aka an arena for values of arbitrary types.
Documentation
use core::{
    mem::transmute,
    ptr::{self, NonNull},
};

use crate::{
    FixedBumpVec, SizedTypeProperties,
    bump_box::RawBumpBox,
    error_behavior::ErrorBehavior,
    polyfill::{non_null, transmute_mut, transmute_ref},
    set_len_on_drop_by_ptr::SetLenOnDropByPtr,
    traits::{BumpAllocatorTyped, MutBumpAllocatorTyped},
};

/// Like [`FixedBumpVec`] but without its lifetime.
#[repr(C)]
pub struct RawFixedBumpVec<T> {
    initialized: RawBumpBox<[T]>,
    capacity: usize,
}

impl<T> RawFixedBumpVec<T> {
    pub(crate) const EMPTY: Self = RawFixedBumpVec {
        initialized: RawBumpBox::EMPTY,
        capacity: if T::IS_ZST { usize::MAX } else { 0 },
    };

    #[inline(always)]
    pub(crate) const unsafe fn cook<'a>(self) -> FixedBumpVec<'a, T> {
        unsafe { transmute(self) }
    }

    #[inline(always)]
    pub(crate) const unsafe fn cook_ref<'a>(&self) -> &FixedBumpVec<'a, T> {
        unsafe { transmute_ref(self) }
    }

    #[inline(always)]
    pub(crate) unsafe fn cook_mut<'a>(&mut self) -> &mut FixedBumpVec<'a, T> {
        unsafe { transmute_mut(self) }
    }

    #[inline(always)]
    pub(crate) unsafe fn from_cooked(cooked: FixedBumpVec<'_, T>) -> Self {
        unsafe {
            let (initialized, capacity) = cooked.into_raw_parts();
            let initialized = RawBumpBox::from_cooked(initialized);
            Self { initialized, capacity }
        }
    }

    #[inline(always)]
    pub(crate) unsafe fn allocate<B: ErrorBehavior>(allocator: &impl BumpAllocatorTyped, len: usize) -> Result<Self, B> {
        let ptr = B::allocate_slice::<T>(allocator, len)?;

        Ok(Self {
            initialized: unsafe { RawBumpBox::from_ptr(NonNull::slice_from_raw_parts(ptr, 0)) },
            capacity: len,
        })
    }

    #[inline(always)]
    pub(crate) unsafe fn prepare_allocation<B: ErrorBehavior>(
        allocator: &mut impl MutBumpAllocatorTyped,
        len: usize,
    ) -> Result<Self, B> {
        unsafe {
            let allocation = B::prepare_slice_allocation::<T>(allocator, len)?;

            Ok(Self {
                initialized: RawBumpBox::from_ptr(NonNull::slice_from_raw_parts(non_null::as_non_null_ptr(allocation), 0)),
                capacity: allocation.len(),
            })
        }
    }

    /// `new_cap` must be greater than `self.capacity`
    pub(crate) unsafe fn grow_prepared_allocation<B: ErrorBehavior>(
        &mut self,
        allocator: &mut impl MutBumpAllocatorTyped,
        minimum_new_cap: usize,
    ) -> Result<(), B> {
        unsafe {
            debug_assert!(minimum_new_cap > self.capacity);
            let allocation = B::prepare_slice_allocation::<T>(allocator, minimum_new_cap)?;

            let new_ptr = allocation.cast::<T>();
            let new_cap = allocation.len();

            ptr::copy_nonoverlapping(self.as_ptr(), new_ptr.as_ptr(), self.len());

            self.initialized.set_ptr(new_ptr);
            self.capacity = new_cap;

            Ok(())
        }
    }

    #[inline(always)]
    pub(crate) const fn len(&self) -> usize {
        self.initialized.len()
    }

    #[inline(always)]
    pub(crate) const fn capacity(&self) -> usize {
        self.capacity
    }

    #[inline(always)]
    pub(crate) fn as_ptr(&self) -> *const T {
        self.initialized.as_ptr().cast()
    }

    #[inline(always)]
    pub(crate) fn as_mut_ptr(&mut self) -> *mut T {
        self.initialized.as_mut_ptr().cast()
    }

    #[must_use]
    #[inline(always)]
    pub const fn as_non_null(&self) -> NonNull<T> {
        self.initialized.as_non_null().cast()
    }

    #[inline(always)]
    pub(crate) unsafe fn set_ptr(&mut self, new_ptr: NonNull<T>) {
        unsafe { self.initialized.set_ptr(new_ptr) };
    }

    #[inline(always)]
    pub(crate) unsafe fn set_len(&mut self, new_len: usize) {
        unsafe { self.initialized.set_len(new_len) };
    }

    #[inline(always)]
    pub(crate) unsafe fn set_cap(&mut self, new_cap: usize) {
        self.capacity = new_cap;
    }

    #[inline(always)]
    pub(crate) unsafe fn set_len_on_drop(&mut self) -> SetLenOnDropByPtr<'_, T> {
        SetLenOnDropByPtr::new(&mut self.initialized.ptr)
    }

    #[inline(always)]
    pub(crate) fn into_raw_parts(self) -> (NonNull<[T]>, usize) {
        let Self { initialized, capacity } = self;
        (initialized.into_ptr(), capacity)
    }

    #[inline(always)]
    pub(crate) unsafe fn from_raw_parts(slice: NonNull<[T]>, capacity: usize) -> Self {
        Self {
            initialized: unsafe { RawBumpBox::from_ptr(slice) },
            capacity,
        }
    }
}