Struct rate_common::memory::Array

pub struct Array<I: Offset, T> {
    pub data: Vector<T>,
    pub phantom: PhantomData<I>,
}

A contiguous non-growable array type with strongly-typed indexing.

The first template argument specifies the type that can be used for indexing the array. The second template argument specifies the type of the elements in the array.

An Array can be used as a fixed size map or set data structure. The maximum index must be set at construction time, which will allocate an area of memory of that size. As a result, this can be quite memory-consuming for sparse maps or sets, but it is as efficient as it gets for fast lookups.

Fields

data: Vector<T>

The vector of elements

phantom: PhantomData<I>

Zero-sized field to appease the compiler, since I is not used in any other field

Methods

impl<I: Offset, T: Clone> Array<I, T>

pub fn new(value: T, size: usize) -> Array<I, T>

Create a new array of size size with all elements set to value.

impl<I: Offset, T> Array<I, T>

pub fn with_capacity(size: usize) -> Array<I, T>

Create a new array of size size without initializing its elements.

pub fn from(data: Vector<T>) -> Array<I, T>

Create a new array by taking ownership of a Vector.

pub fn size(&self) -> usize

Returns the size of the array.

Trait Implementations

impl<I: Offset, T: HeapSpace> HeapSpace for Array<I, T>

fn heap_space(&self) -> usize

The number of bytes allocated on the heap that this owns.

impl<I: Eq + Offset, T: Eq> Eq for Array<I, T>

impl<I: Offset, T> AsMut<Array<I, T>> for Array<I, T>

fn as_mut(&mut self) -> &mut Array<I, T>

Performs the conversion.

impl<I: Offset, T> AsMut<[T]> for Array<I, T>

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl<I: Offset, T> Default for Array<I, T>

fn default() -> Array<I, T>

Returns the "default value" for a type.

impl<I: Clone + Offset, T: Clone> Clone for Array<I, T>

fn clone(&self) -> Array<I, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Offset, T> AsRef<Array<I, T>> for Array<I, T>

fn as_ref(&self) -> &Array<I, T>

Performs the conversion.

impl<I: Offset, T> AsRef<[T]> for Array<I, T>

fn as_ref(&self) -> &[T]

Performs the conversion.

impl<I: PartialEq + Offset, T: PartialEq> PartialEq<Array<I, T>> for Array<I, T>

fn eq(&self, other: &Array<I, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Array<I, T>) -> bool

This method tests for !=.

impl<I: Offset, T> Deref for Array<I, T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &[T]

Dereferences the value.

impl<I: Offset, T> DerefMut for Array<I, T>

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.

impl<I: Offset, T> Index<I> for Array<I, T>

type Output = T

The returned type after indexing.

fn index(&self, key: I) -> &T

Performs the indexing (container[index]) operation.

impl<I: Offset, T> IndexMut<I> for Array<I, T>

fn index_mut(&mut self, key: I) -> &mut T

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

impl<I: Debug + Offset, T: Debug> Debug for Array<I, T>

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

Formats the value using the given formatter.