Struct Idx 

pub struct Idx<T> { /* private fields */ }

A typed index into an arena.

This is a zero-cost abstraction over u32 that provides type safety. Equality checks are O(1) pointer comparisons.

Implementations

impl<T> Idx<T>

pub fn raw(&self) -> u32

Get the raw index value.

pub fn cast<U>(self) -> Idx<U>

Cast to a different type without changing the raw index.

Safety

The caller must ensure the reinterpreted index is valid.

pub fn is_first(self) -> bool

Check whether this index is the first (index 0).

pub fn next(self) -> Self

Increment the index by 1 (without bounds checking).

pub fn to_usize(self) -> usize

Convert to usize for slice indexing.

Trait Implementations

impl<T: Clone> Clone for Idx<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Idx<T>

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

Formats the value using the given formatter.

impl<T> Display for Idx<T>

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

Formats the value using the given formatter.

impl<T> Hash for Idx<T>

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> Index<Idx<T>> for Arena<T>

type Output = T

The returned type after indexing.

fn index(&self, idx: Idx<T>) -> &T

Performs the indexing (container[index]) operation.

impl<T> Ord for Idx<T>

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> PartialEq for Idx<T>

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

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

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> PartialOrd for Idx<T>

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: Copy> Copy for Idx<T>

impl<T> Eq for Idx<T>