Struct Index

pub struct Index { /* private fields */ }

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 rapier::data::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(index: u32, generation: u32) -> 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) -> (u32, u32)

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

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Index

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

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Index> for ColliderSet

type Output = Collider

The returned type after indexing.

fn index(&self, index: Index) -> &Collider

Performs the indexing (container[index]) operation.

impl Index<Index> for RigidBodySet

type Output = RigidBody

The returned type after indexing.

fn index(&self, index: Index) -> &RigidBody

Performs the indexing (container[index]) operation.

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

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

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

impl IndexedData for Index

fn default() -> Self

Creates a new default instance of Self.

fn index(&self) -> usize

Gets the index associated to self.

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