Struct MultiArrayList

pub struct MultiArrayList<T>
where
    T: Facet<'static>,
{ /* private fields */ }

A MultiArrayList stores a list of a struct.

Instead of storing a single list of items, MultiArrayList stores separate lists for each field of the struct. This allows for memory savings if the struct has padding, and also improves cache usage if only some fields are needed for a computation.

The primary API for accessing fields is the items(name) function.

Implementations

impl<T> MultiArrayList<T>

where T: Facet<'static>,

pub fn new() -> MultiArrayList<T>

Constructs a new, empty MultiArrayList<T>.

Examples

#[derive(Facet)]
struct Point {
    x: i32,
    y: i32
}
let mut list: MultiArrayList<Point> = MultiArrayList::new();

pub fn capacity(&self) -> usize

Returns the total number of elements the vector can hold without reallocating.

pub fn len(&self) -> usize

Returns the number of elements in the MultiArrayList, also referred to as its ‘length’.

pub fn push(&mut self, value: T)

Appends an element to the back of a collection.

pub fn pop(&mut self) -> Option<T>

Removes the last element from the MultiArrayList and returns it, or None if it is empty.

pub fn iter<'a>(&'a self) -> Iter<'a, T>

Returns an iterator over the MultiArrayList.

The iterator yields all items from start to end.

pub fn items<'a, V>(&'a self, name: &'static str) -> Slice<'a, V>

where V: Facet<'static>,

Get an iterator of values for a specified field.

Panics

• Panics if the requested field does not exit.
• Panics if the requested type does not match the found field.

pub fn items_mut<'a, V>(&'a mut self, name: &'static str) -> SliceMut<'a, V>

where V: Facet<'static>,

Get an iterator of mutable values for a specified field.

Panics

• Panics if the requested field does not exit.
• Panics if the requested type does not match the found field.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

Trait Implementations

impl<T> Debug for MultiArrayList<T>

where T: Facet<'static> + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Drop for MultiArrayList<T>

where T: Facet<'static>,

fn drop(&mut self)

Executes the destructor for this type.