HeapArray

This crate aims to give people better control of how they want to allocate memory, by providing a customizable way to allocate blocks of memory, that optionally contains metadata about the block itself.

It's suggested that you import the contents of this crate with use heaparray::*;, as a lot of the functionality of the structs in this crate are implemented through traits.

Features

• Arrays are allocated on the heap
• Swap owned objects in and out with array.insert()

Examples

Creating an array:

use heaparray::*;
let len = 10;
let array = HeapArray::new(len, |idx| idx + 3);

Indexing works as you would expect:

# 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:

# 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:

# 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
        }
    });

Future Plans

Iteration, allocator customization, reference counting (RcArray), and atomic reference counting (ArcArray).