Struct Index

pub struct Index { /* private fields */ }

Index type for Arena that has a generation attached to it.

Implementations

impl Index

pub const DANGLING: Index

Represents an Index that is unlikely to be in use. This is useful for programs that want to do two-phase initialization in safe Rust. Avoid using this value to represent the absence of an Index: prefer Option<Index>.

pub const fn to_bits(self) -> u64

Convert this Index to an equivalent u64 representation. Mostly useful for passing to code outside of Rust.

pub const fn from_bits(bits: u64) -> Option<Index>

Create an Index from bits created with Index::to_bits.

If this function is called with bits that are not valid for an Index, returns None. This can happen if the encoded generation value is 0, for example.

Stability

Bits from Index values are guaranteed to be compatible within all semver-compatible versions of Thunderdome. That is, using Index::to_bits in 0.4.0 and Index::from_bits in 0.4.2 is guaranteed to work.

pub const fn generation(self) -> u32

Convert this Index into a generation, discarding its slot.

pub const fn slot(self) -> u32

Convert this Index into a slot, discarding its generation. Slots describe a location in an Arena and are reused when entries are removed.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Hash for Index

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

where __H: Hasher,

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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

impl Ord for Index

fn cmp(&self, other: &Index) -> 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 PartialEq for Index

fn eq(&self, other: &Index) -> 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 PartialOrd for Index

fn partial_cmp(&self, other: &Index) -> 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 Copy for Index

impl Eq for Index

impl StructuralPartialEq for Index