Struct ComponentIndex 

pub struct ComponentIndex(/* private fields */);

Index within a component’s component index space.

Implementations

impl ComponentIndex

pub fn from_u32(x: u32) -> Self

Create a new instance from a u32.

pub fn as_u32(self) -> u32

Return the underlying index value as a u32.

pub fn as_bits(self) -> u32

Return the raw bit encoding for this instance.

Warning: the raw bit encoding is opaque and has no guaranteed correspondence to the entity’s index. It encodes the entire state of this index value: either a valid index or an invalid-index sentinel. The value returned by this method should only be passed to from_bits.

pub fn from_bits(x: u32) -> Self

Create a new instance from the raw bit encoding.

Warning: the raw bit encoding is opaque and has no guaranteed correspondence to the entity’s index. It encodes the entire state of this index value: either a valid index or an invalid-index sentinel. The value returned by this method should only be given bits from as_bits.

Trait Implementations

impl Clone for ComponentIndex

fn clone(&self) -> ComponentIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComponentIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EntityRef for ComponentIndex

fn new(index: usize) -> Self

Create a new entity reference from a small integer. This should crash if the requested index is not representable.

fn index(self) -> usize

Get the index that was used to create this entity reference.

impl Hash for ComponentIndex

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 Ord for ComponentIndex

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

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

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

fn reserved_value() -> ComponentIndex

Create an instance of the reserved value.

fn is_reserved_value(&self) -> bool

Checks whether value is the reserved one.

impl Serialize for ComponentIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ComponentIndex

impl Eq for ComponentIndex

impl StructuralPartialEq for ComponentIndex