Struct Index

pub struct Index<T, I = usize, G = u64> { /* private fields */ }

An index (and generation) into an Arena.

To get an Index, insert an element into an Arena, and the Index for that element will be returned.

Examples

use typed_generational_arena::StandardArena;

let mut arena = StandardArena::new();
let idx = arena.insert(123);
assert_eq!(arena[idx], 123);

Implementations

impl<T, I: ArenaIndex + Copy, G: FixedGenerationalIndex + Copy> Index<T, I, G>

pub fn to_idx(&self) -> usize

Get this index as a usize

pub fn arr_idx(&self) -> I

Get this index’s array index into the arena

pub fn gen(&self) -> G

Get this index’s generation

impl<T, I: ArenaIndex + Copy, G: FixedGenerationalIndex> Index<T, I, G>

pub fn from_idx_first_gen(n: usize) -> Self

Convert a usize to an index at the first generation

impl<T, I: ArenaIndex + Copy, G: IgnoredGeneration> Index<T, I, G>

pub fn from_idx(n: usize) -> Self

Convert a usize to an index (with generations ignored)

impl<T, I: ArenaIndex, G: FixedGenerationalIndex> Index<T, I, G>

pub fn new(index: I, generation: G) -> Index<T, I, G>

Create a new index from a given array index and generation

Trait Implementations

impl<T, I: Clone, G: Clone> Clone for Index<T, I, G>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, I: Debug, G: Debug> Debug for Index<T, I, G>

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

Formats the value using the given formatter.

impl<T, I: Hash, G: Hash> Hash for Index<T, I, G>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, I: ArenaIndex, G: FixedGenerationalIndex> Index<Index<T, I, G>> for Arena<T, I, G>

type Output = T

The returned type after indexing.

fn index(&self, index: Index<T, I, G>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, I: ArenaIndex, G: FixedGenerationalIndex> IndexMut<Index<T, I, G>> for Arena<T, I, G>

fn index_mut(&mut self, index: Index<T, I, G>) -> &mut Self::Output

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

impl<T, I: Ord, G: FixedGenerationalIndex> Ord for Index<T, I, G>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T, I: PartialEq, G: PartialEq> PartialEq for Index<T, I, G>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, I: PartialOrd, G: FixedGenerationalIndex> PartialOrd for Index<T, I, G>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, I: Copy, G: Copy> Copy for Index<T, I, G>

impl<T, I: Eq, G: Eq> Eq for Index<T, I, G>