platform-mem 0.2.0

Memory for linksplatform
Documentation
use {
    crate::{
        Error::{AllocError, CapacityOverflow},
        RawMem, RawPlace, Result, utils,
    },
    allocator_api2::alloc::Allocator,
    std::{
        alloc::Layout,
        fmt::{self, Debug, Formatter},
        mem::{self, MaybeUninit},
        ptr,
    },
};

/// Allocator-backed memory storage.
///
/// Wraps any [`Allocator`] to provide a [`RawMem`] implementation.
/// Memory is freed and elements are dropped when the `Alloc` is dropped.
pub struct Alloc<T, A: Allocator> {
    buf: RawPlace<T>,
    alloc: A,
}

impl<T, A: Allocator> Alloc<T, A> {
    /// Construct a new empty `Alloc<T, A>`.
    /// It will not allocate until [growing][RawMem::grow].
    /// ```
    /// # use platform_mem::Global;
    /// // It's able to be static
    /// static ALLOC: Global<()> = Global::new();
    /// ```
    pub const fn new(alloc: A) -> Self {
        Self { buf: RawPlace::dangling(), alloc }
    }
}

impl<T, A: Allocator> RawMem for Alloc<T, A> {
    type Item = T;

    fn allocated(&self) -> &[Self::Item] {
        unsafe { self.buf.as_slice() }
    }

    fn allocated_mut(&mut self) -> &mut [Self::Item] {
        unsafe { self.buf.as_slice_mut() }
    }

    unsafe fn grow(
        &mut self,
        addition: usize,
        fill: impl FnOnce(usize, (&mut [T], &mut [MaybeUninit<T>])),
    ) -> Result<&mut [T]> {
        unsafe {
            let cap = self.buf.cap().checked_add(addition).ok_or(CapacityOverflow)?;
            let new_layout = Layout::array::<T>(cap).map_err(|_| CapacityOverflow)?;

            let ptr = if let Some((ptr, old_layout)) = self.buf.current_memory() {
                self.alloc.grow(ptr, old_layout, new_layout)
            } else {
                self.alloc.allocate(new_layout)
            }
            .map_err(|_| AllocError { layout: new_layout, non_exhaustive: () })?
            .cast();

            // allocator always provide uninit memory
            Ok(self.buf.handle_fill((ptr, cap), 0, fill))
        }
    }

    fn shrink(&mut self, cap: usize) -> Result<()> {
        let cap = self.buf.cap().checked_sub(cap).expect("Tried to shrink to a larger capacity");

        let Some((ptr, layout)) = self.buf.current_memory() else {
            return Ok(());
        };
        self.buf.shrink_to(cap);

        let ptr = unsafe {
            // `Layout::array` cannot overflow here because it would have
            // overflowed earlier when capacity was larger.
            let new_size = mem::size_of::<T>().unchecked_mul(cap);
            let new_layout = Layout::from_size_align_unchecked(new_size, layout.align());
            self.alloc
                .shrink(ptr, layout, new_layout)
                .map_err(|_| AllocError { layout: new_layout, non_exhaustive: () })?
        };

        #[allow(clippy::unit_arg)] // it is allows shortest return `Ok(())`
        Ok({
            self.buf.set_ptr(ptr);
        })
    }
}

impl<T, A: Allocator> Drop for Alloc<T, A> {
    fn drop(&mut self) {
        unsafe {
            if let Some((ptr, layout)) = self.buf.current_memory() {
                ptr::drop_in_place(self.buf.as_slice_mut());
                self.alloc.deallocate(ptr, layout);
            }
        }
    }
}

impl<T, A: Allocator + Debug> Debug for Alloc<T, A> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        utils::debug_mem(f, &self.buf, "Alloc")?.field("alloc", &self.alloc).finish()
    }
}