Struct EntityLoc

pub struct EntityLoc<'a> { /* private fields */ }

Entity reference that is guaranteed to be alive. The value is bound to the world borrow that prevents the entity from being removed. The entity location is known.

Implementations

impl EntityLoc<'_>

pub fn id(&self) -> EntityId

Returns entity id.

Trait Implementations

impl<'a> AliveEntity for EntityLoc<'a>

fn entity_ref<'b>(&self, _world: &'b mut World) -> EntityRef<'b>

Returns entity reference if it is alive.

fn locate(&self, _entities: &EntitySet) -> Location

Returns entity location.

fn entity_loc<'b>(&self, _entities: &'b EntitySet) -> EntityLoc<'b>

Returns entity with bound location.

impl<'a> Clone for EntityLoc<'a>

fn clone(&self) -> EntityLoc<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityLoc<'_>

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

Formats the value using the given formatter.

impl Display for EntityLoc<'_>

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

Formats the value using the given formatter.

impl<'a> Entity for EntityLoc<'a>

fn entity_ref<'b>(&self, _world: &'b mut World) -> Option<EntityRef<'b>>

Returns entity reference if it is alive.

fn id(&self) -> EntityId

Returns entity id which is the weakest reference to the entity.

fn lookup(&self, _entities: &EntitySet) -> Option<Location>

Returns entity location if it is alive.

fn is_alive(&self, _entities: &EntitySet) -> bool

Checks if the entity is alive.

fn entity_loc<'b>(&self, _entities: &'b EntitySet) -> Option<EntityLoc<'b>>

Returns entity with bound location if it is alive.

impl<'a> Hash for EntityLoc<'a>

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<'a> Ord for EntityLoc<'a>

fn cmp(&self, other: &EntityLoc<'a>) -> 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<EntityBound<'_>> for EntityLoc<'_>

fn eq(&self, other: &EntityBound<'_>) -> 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 PartialEq<EntityId> for EntityLoc<'_>

fn eq(&self, other: &EntityId) -> 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 PartialEq<EntityLoc<'_>> for EntityBound<'_>

fn eq(&self, other: &EntityLoc<'_>) -> 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 PartialEq<EntityLoc<'_>> for EntityId

fn eq(&self, other: &EntityLoc<'_>) -> 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 PartialEq<EntityLoc<'_>> for EntityRef<'_>

fn eq(&self, other: &EntityLoc<'_>) -> 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 PartialEq<EntityLoc<'_>> for FlowEntity

fn eq(&self, other: &EntityLoc<'_>) -> 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 PartialEq<EntityRef<'_>> for EntityLoc<'_>

fn eq(&self, other: &EntityRef<'_>) -> 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 PartialEq<FlowEntity> for EntityLoc<'_>

fn eq(&self, other: &FlowEntity) -> 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<'a> PartialEq for EntityLoc<'a>

fn eq(&self, other: &EntityLoc<'a>) -> 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<'a> PartialOrd for EntityLoc<'a>

fn partial_cmp(&self, other: &EntityLoc<'a>) -> 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<'a> Copy for EntityLoc<'a>

impl<'a> Eq for EntityLoc<'a>

impl<'a> StructuralPartialEq for EntityLoc<'a>