Struct OptionsId

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

Implementations

impl OptionsId

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 OptionsId

fn clone(&self) -> OptionsId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionsId

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

Formats the value using the given formatter.

impl EntityRef for OptionsId

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 OptionsId

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 PartialEq for OptionsId

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

fn reserved_value() -> OptionsId

Create an instance of the reserved value.

fn is_reserved_value(&self) -> bool

Checks whether value is the reserved one.

impl Copy for OptionsId

impl Eq for OptionsId

impl StructuralPartialEq for OptionsId