heaparray 0.1.6

// use crate::fat_array_ptr::FatPtrArray;
pub use crate::prelude::*;

/// Heap-allocated array, with array size stored with the pointer to the memory.
///
/// ## Examples
///
/// Creating an array:
/// ```rust
/// use heaparray::*;
/// let len = 10;
/// let array = HeapArray::new(len, |idx| idx + 3);
/// ```
///
/// Indexing works as you would expect:
/// ```rust
/// # use heaparray::*;
/// # let mut array = HeapArray::new(10, |idx| idx + 3);
/// array[3] = 2;
/// assert!(array[3] == 2);
/// ```
///
/// Notably, you can take ownership of objects back from the container:
///
/// ```rust
/// # use heaparray::*;
/// let mut array = HeapArray::new(10, |_| Vec::<u8>::new());
/// let replacement_object = Vec::new();
/// let owned_object = array.insert(0, replacement_object);
/// ```
///
/// but you need to give the array a replacement object to fill its slot with.
///
/// Additionally, you can customize what information should be stored alongside the elements in
/// the array using the HeapArray::new_labelled function:
///
/// ```rust
/// # use heaparray::*;
/// struct MyLabel {
///     pub even: usize,
///     pub odd: usize,
/// }
///
/// let mut array = HeapArray::new_labelled(
///     MyLabel { even: 0, odd: 0 },
///     100,
///     |label, index| {
///         if index % 2 == 0 {
///             label.even += 1;
///             index
///         } else {
///             label.odd += 1;
///             index
///         }
///     });
/// ```
/// # Invariants
/// This struct follows the same invariants as mentioned in `crate::memory_block`,
/// and does not check for pointer validity; you should use this struct in the same
/// way you would use a raw array or slice.
pub use crate::fat_array_ptr::FatPtrArray as HeapArray;

// #[repr(transparent)]
// pub struct HeapArray<'a, E, L = ()>(FatPtrArray<'a, E, L>);
//
// impl<'a, E> HeapArray<'a, E> {
//     /// Create a new array, with values initialized using a provided function.
//     #[inline]
//     pub fn new<F>(len: usize, mut func: F) -> Self
//     where
//         F: FnMut(usize) -> E,
//     {
//         FatPtrArray::<'a, E, L>::new_labelled((), len, |_, idx| func(idx))
//     }
// }
//
// impl<'a, E, L> HeapArray<'a, E, L> {
//     /// Create a new array, with values initialized using a provided function, and label
//     /// initialized to a provided value.
//     #[inline]
//     pub fn new_labelled<F>(label: L, len: usize, func: F) -> Self
//     where
//         F: FnMut(&mut L, usize) -> E,
//     {
//         Self(FatPtrArray::<'a, E, L>::new_labelled(label, len, func))
//     }
//
//     /// Create a new array, without initializing the values in it.
//     #[inline]
//     pub unsafe fn new_labelled_unsafe(label: L, len: usize) -> Self {
//         Self(FatPtrArray::<'a, E, L>::new_labelled_unsafe(label, len))
//     }
//
//     /// Creates a new array from a raw pointer to a memory block.
//     #[inline]
//     pub unsafe fn from_raw_parts(ptr: &'a mut FPArrayBlock<E, L>) -> Self {
//         Self(FatPtrArray::<'a, E, L>::from_raw_parts(ptr))
//     }
//
//     /// Unsafe access to an element at an index in the array.
//     #[inline]
//     pub unsafe fn unchecked_access(&'a self, idx: usize) -> &'a mut E {
//         self.data.unchecked_access(idx)
//     }
//
//     /// Sets the internal pointer to null, without deallocating it, and returns
//     /// reference to the associated memory block.
//     /// Causes all sorts of undefined behavior, use with caution.
//     pub unsafe fn to_null(&mut self) -> &mut FPArrayBlock<E, L> {
//         core::mem::replace(&mut *self, Self::null_ref()).data
//     }
//
//     /// Creates a null array. All kinds of UB associated with this, use
//     /// with caution.
//     pub unsafe fn null_ref() -> Self {
//         Self {
//             data: &mut *(FPArrayBlock::null_ptr()),
//         }
//     }
//
//     /// Returns whether the internal pointer of this struct is null. Should always
//     /// return false unless you use the unsafe API.
//     pub fn is_null(&self) -> bool {
//         self.data.is_null()
//     }
// }
//
// impl<'a, E> HeapArray<'a, E>
// where
//     E: Default,
// {
//     /// Get a new array, initialized to default values.
//     #[inline]
//     pub fn new_default(len: usize) -> Self {
//         Self::new_default_labelled((), len)
//     }
// }
//
// impl<'a, E, L> HeapArray<'a, E, L>
// where
//     E: Default,
// {
//     /// Get a new array, initialized to default values.
//     #[inline]
//     pub fn new_default_labelled(label: L, len: usize) -> Self {
//         Self {
//             data: FPArrayBlock::new_ptr_default(label, len),
//         }
//     }
// }
//
// impl<'a, E, L> Index<usize> for HeapArray<'a, E, L> {
//     type Output = E;
//     #[inline]
//     fn index(&self, idx: usize) -> &E {
//         &self.data[idx]
//     }
// }
//
// impl<'a, E, L> IndexMut<usize> for HeapArray<'a, E, L> {
//     #[inline]
//     fn index_mut(&mut self, idx: usize) -> &mut E {
//         &mut self.data[idx]
//     }
// }
//
// impl<'a, E, L> Clone for HeapArray<'a, E, L>
// where
//     L: Clone,
//     E: Clone,
// {
//     #[inline]
//     fn clone(&self) -> Self {
//         Self(self.0.clone())
//     }
// }
//
// impl<'a, E, L> Container<(usize, E)> for HeapArray<'a, E, L> {
//     #[inline]
//     fn add(&mut self, elem: (usize, E)) {
//         self.0.add(elem)
//     }
//     #[inline]
//     fn len(&self) -> usize {
//         self.0.len()
//     }
// }
//
// impl<'a, E, L> CopyMap<'a, usize, E> for HeapArray<'a, E, L>
// where
//     E: 'a,
// {
//     #[inline]
//     fn get(&'a self, key: usize) -> Option<&'a E> {
//         self.0.get(key)
//     }
//     #[inline]
//     fn get_mut(&'a mut self, key: usize) -> Option<&'a mut E> {
//         self.0.get_mut(key)
//     }
//     #[inline]
//     fn insert(&mut self, key: usize, value: E) -> Option<E> {
//         self.0.insert(key, value)
//     }
// }
//
// impl<'a, E, L> Array<'a, E> for HeapArray<'a, E, L> where E: 'a {}
//
// impl<'a, E, L> LabelledArray<'a, E, L> for HeapArray<'a, E, L>
// where
//     E: 'a,
// {
//     /// Get a reference to the label of the array.
//     #[inline]
//     fn get_label(&self) -> &L {
//         self.0.get_label()
//     }
//
//     /// Get a mutable reference to the label of the array.
//     #[inline]
//     fn get_label_mut(&mut self) -> &mut L {
//         self.0.get_label_mut()
//     }
// }