Struct typed_generational_arena::Index

pub struct Index<T> { /* fields omitted */ }

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::Arena;

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

Trait Implementations

impl<T: PartialEq> PartialEq<Index<T>> for Index<T>

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

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

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

This method tests for !=.

impl<T: Eq> Eq for Index<T>

impl<T: Ord> Ord for Index<T>

fn cmp(&self, other: &Index<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialOrd> PartialOrd<Index<T>> for Index<T>

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

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

fn lt(&self, other: &Index<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Index<T>) -> bool

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

fn gt(&self, other: &Index<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Index<T>) -> bool

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

impl<T: Hash> Hash for Index<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T> Copy for Index<T>

impl<T> Index<Index<T>> for Arena<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Index<T>> for Arena<T>

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

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

impl<T: Debug> Debug for Index<T>

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

Formats the value using the given formatter.

impl<T> Clone for Index<T>

fn clone(&self) -> Index<T>

Returns a copy of the value.

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

Performs copy-assignment from source.