Struct Entity 

pub struct Entity {
    index: u32,
    generation: u32,
    name: &'static str,
}

A handle to an entity.

The handle is a plain value: it stays valid across world mutations as long as the entity lives, and resolves to nothing once the entity is despawned.

It also carries a name, which Debug prints. A name is given where the entity is made: a crate::bundle! names it after its own source position, crate::DynamicBundle::named and crate::ScopeMut::spawn_named after the string the caller passed, and crate::World::reserve_entity at the reservation. Two handles to one entity can carry different names and still be equal, because a handle restored from Entity::to_bits has no name to restore; crate::Scope::entity_name reads the one the row stores.

Fields

index: u32

generation: u32

name: &'static str

Implementations

impl Entity

pub const fn from_raw(index: u32, generation: u32) -> Self

Build a handle from raw parts.

The handle only refers to an entity if it was produced by the same world, so this is for restoring a handle that came from that world (a save file, for example).

pub const fn name(self) -> &'static str

The name part, empty when the handle was restored rather than spawned.

pub const fn index(self) -> u32

The index part.

pub const fn generation(self) -> u32

The generation part.

pub const fn to_bits(self) -> u64

The two parts as one value, generation high.

This is not the order Ord uses: the comparison is by index first, then generation, which is what makes entities spawned together sort together.

pub const fn from_bits(bits: u64) -> Self

The handle Entity::to_bits produced.

The handle only refers to an entity if it was produced by the same world, so this is for restoring a handle that came from that world. The restored handle carries no name.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Entity

impl Debug for Entity

Prints the name and the bits the handle travels as, and not the index and generation they are made of: those are the allocator’s business, while the bits are the only part a caller holds when the handle came over a wire.

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

Formats the value using the given formatter.

impl Eq for Entity

impl From<&Entity> for EntityProxy

Available on crate feature reflect only.

fn from(value: &Entity) -> Self

Converts to this type from the input type.

impl From<EntityProxy> for Entity

Available on crate feature reflect only.

fn from(proxy: EntityProxy) -> Self

Converts to this type from the input type.

impl Hash for Entity

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 Entity

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Entity

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Entity

fn partial_cmp(&self, other: &Self) -> 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 Query for Entity

Asks for the entity itself.

It is an item like any other, so it can be written first, last, or on its own: a query over Entity alone yields every entity the scope sees.

type Item<'a> = Entity

What one matched row yields.

type Plan<'w> = &'w [Entity]

What is resolved once per archetype and then read once per row.

fn prepare<'w>(builder: &mut PlanBuilder<'w>) -> Option<Self::Plan<'w>>

Resolve the plan for one archetype.

fn read<'a, 'w: 'a>(plan: &'a mut Self::Plan<'w>, row: usize) -> Self::Item<'a>

Read the row at row through the resolved plan.