Struct ngen::arena::array::Array

pub struct Array<'t, T> { /* fields omitted */ }

A growable array of elements for a temporary memory arena.

Implementations

impl<'t, T> Array<'t, T>

pub fn new(arena: &'t mut TempArena) -> Self

Creates a new array, using the supplied temporary arena allocator as its backing store.

Example

let mut arena = TempArena::with_capacity(1024).unwrap();
let array = Array::<u32>::new(&mut arena);

Note

Instead of creating the array manually, it is easier to use the array method of the TempArena.

let mut arena = TempArena::with_capacity(1024).unwrap();
let array = arena.array::<u32>();

Note

Arrays can be indexed, just like other collections in Rust.

let mut arena = TempArena::with_capacity(1024).unwrap();
let mut array = arena.array();

array.push(0);
array.push(1);
array.push(2);

assert_eq!(array[1], 1);

array[0] = 42;
assert_eq!(array[0], 42);

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

Pushes a new element onto the end of the array.

Example

let mut arena = TempArena::with_capacity(1024).unwrap();
let mut array = arena.array();

array.push(7);
array.push(42);

pub const fn len(&self) -> usize

Returns the current length of the array.

Example

let mut arena = TempArena::with_capacity(1024).unwrap();
let mut array = arena.array();

array.push(7);
array.push(42);

assert_eq!(array.len(), 2);

pub fn end(self) -> &'t mut [T]

Ends the array, returning a slice that points to the array's elements. This is important because it returns access to the temp arena to the rest of the application.

Example

let mut arena = TempArena::with_capacity(1024).unwrap();
let mut array = arena.array();

for i in 0..42 {
    array.push(i);
}

for (c, i) in array.end().iter().enumerate() {
    assert_eq!(*i, c as i32);
}

Trait Implementations

impl<'t, T> Index<usize> for Array<'t, T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'t, T> IndexMut<usize> for Array<'t, T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.