Struct generational_arena::Index

pub struct Index { /* fields omitted */ }

[−] Expand description

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

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

Implementations

impl Index

pub fn from_raw_parts(a: usize, b: u64) -> Index[−]

Create a new Index from its raw parts.

The parts must have been returned from an earlier call to into_raw_parts.

Providing arbitrary values will lead to malformed indices and ultimately panics.

pub fn into_raw_parts(self) -> (usize, u64)[−]

Convert this Index into its raw parts.

This niche method is useful for converting an Index into another identifier type. Usually, you should prefer a newtype wrapper around Index like pub struct MyIdentifier(Index);. However, for external types whose definition you can’t customize, but which you can construct instances of, this method can be useful.

Trait Implementations

impl Clone for Index

[+] Show hidden undocumented items

fn clone(&self) -> Index[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Index

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Hash for Index

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

[+] Show hidden undocumented items

type Output = T

The returned type after indexing.

fn index(&self, index: Index) -> &Self::Output[−]

Performs the indexing (container[index]) operation.

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

[+] Show hidden undocumented items

fn index_mut(&mut self, index: Index) -> &mut Self::Output[−]

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

impl Ord for Index

[+] Show hidden undocumented items

fn cmp(&self, other: &Index) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<Index> for Index

[+] Show hidden undocumented items

fn eq(&self, other: &Index) -> bool[−]

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

fn ne(&self, other: &Index) -> bool[−]

This method tests for !=.

impl PartialOrd<Index> for Index

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Index) -> Option<Ordering>[−]

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

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool[−]

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

impl Copy for Index

impl Eq for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index