Struct Idx 

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

Stable index into an Arena or SharedArena.

Obtained from Arena::alloc or SharedArena::alloc. Implements Copy, so it can be freely duplicated and stored in data structures.

Valid as long as the arena has not been reset or rolled back past this index.

Panics

Indexing with a stale Idx (after rollback/reset) panics with an out-of-bounds error.

Implementations

impl<T> Idx<T>

pub const fn into_raw(self) -> usize

Returns the raw index value.

pub const fn from_raw(index: usize) -> Self

Creates an index from a raw value.

The caller must ensure the index is valid for the target arena.

Trait Implementations

impl<T> Clone for Idx<T>

fn clone(&self) -> Self

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Idx<T>> for Arena<T>

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

Performs the mutable 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 for Idx<T>

impl<T> Eq for Idx<T>