Struct bevy::ecs::identifier::Identifier

#[repr(C, align(8))]
pub struct Identifier { /* private fields */ }

A unified identifier for all entity and similar IDs. Has the same size as a u64 integer, but the layout is split between a 32-bit low segment, a 31-bit high segment, and the significant bit reserved as type flags to denote entity kinds.

Implementations

impl Identifier

pub const fn new( low: u32, high: u32, kind: IdKind ) -> Result<Identifier, IdentifierError>

Construct a new Identifier. The high parameter is masked with the kind so to pack the high value and bit flags into the same field.

pub const fn low(self) -> u32

Returns the value of the low segment of the Identifier.

pub const fn high(self) -> NonZeroU32

Returns the value of the high segment of the Identifier. This does not apply any masking.

pub const fn masked_high(self) -> u32

Returns the masked value of the high segment of the Identifier. Does not include the flag bits.

pub const fn kind(self) -> IdKind

Returns the kind of Identifier from the high segment.

pub const fn to_bits(self) -> u64

Convert the Identifier into a u64.

pub const fn from_bits(value: u64) -> Identifier

Convert a u64 into an Identifier.

Panics

This method will likely panic if given u64 values that did not come from Identifier::to_bits.

pub const fn try_from_bits(value: u64) -> Result<Identifier, IdentifierError>

Convert a u64 into an Identifier.

This method is the fallible counterpart to Identifier::from_bits.

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl From<Entity> for Identifier

fn from(value: Entity) -> Identifier

Converts to this type from the input type.

impl Hash for Identifier

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

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

Restrict a value to a certain interval.

impl PartialEq for Identifier

fn eq(&self, other: &Identifier) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Identifier

fn partial_cmp(&self, other: &Identifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<Identifier> for Entity

type Error = IdentifierError

The type returned in the event of a conversion error.

fn try_from( value: Identifier ) -> Result<Entity, <Entity as TryFrom<Identifier>>::Error>

Performs the conversion.

impl Copy for Identifier

impl Eq for Identifier