Struct EntityPropertyTuple 

pub struct EntityPropertyTuple<E: Entity, T> { /* private fields */ }

A newtype wrapper that associates a tuple of property values with an entity type.

This is not meant to be used directly, but rather as a backing for the with! macro/ a replacement for the query tuple.

Example

use ixa::{EntityPropertyTuple, define_entity, define_property};

define_entity!(Person);
define_property!(struct Age(u8), Person, default_const = Age(0));

// Use the all macro
let query = with!(Person, Age(42));
// Under the hood this is:
// EntityPropertyTuple::<Person>::new((Age(42),));

Implementations

impl<E: Entity, T> EntityPropertyTuple<E, T>

pub fn new(inner: T) -> Self

Create a new EntityPropertyTuple wrapping the given tuple.

pub fn inner(&self) -> &T

Returns a reference to the inner tuple.

pub fn into_inner(self) -> T

Consumes self and returns the inner tuple.

Trait Implementations

impl<E: Entity, T: Clone> Clone for EntityPropertyTuple<E, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Entity, T: Debug> Debug for EntityPropertyTuple<E, T>

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

Formats the value using the given formatter.

impl<E: Entity, T: PropertyList<E>> PropertyList<E> for EntityPropertyTuple<E, T>

fn validate() -> Result<(), IxaError>

Validates that the properties are distinct. If not, returns an error describing the problematic properties.

fn contains_properties(property_type_ids: &[TypeId]) -> bool

Checks that this property list includes all properties in the given list.

fn set_values_for_new_entity( &self, entity_id: EntityId<E>, property_store: &mut PropertyStore<E>, )

Assigns the given entity the property values in self in the property_store. This method does NOT emit property change events, as it is called upon entity creation.

fn get_values_for_entity(context: &Context, entity_id: EntityId<E>) -> Self

Gets the tuple of property values for the given entity.

fn contains_required_properties() -> bool

Checks that this property list contains all required properties of the entity.

impl<E: Entity, T: Query<E>> Query<E> for EntityPropertyTuple<E, T>

fn get_query(&self) -> Vec<(usize, HashValueType)>

Returns a list of (type_id, hash) pairs where hash is the hash of the property value and type_id is Property.type_id().

fn get_type_ids(&self) -> Vec<TypeId>

Returns an unordered list of type IDs of the properties in this query.

fn multi_property_id(&self) -> Option<usize>

Returns the TypeId of the multi-property having the properties of this query, if any.

fn multi_property_value_hash(&self) -> HashValueType

If this query is a multi-property query, this method computes the hash of the multi-property value.

fn new_query_result<'c>(&self, context: &'c Context) -> EntitySet<'c, E>

Creates a new query result as an EntitySet.

fn match_entity(&self, entity_id: EntityId<E>, context: &Context) -> bool

Determines if the given person matches this query.

fn filter_entities(&self, entities: &mut Vec<EntityId<E>>, context: &Context)

Removes all EntityIds from the given vector that do not match this query.

fn new_query_result_iterator<'c>( &self, context: &'c Context, ) -> EntitySetIterator<'c, E>

Creates a new EntitySetIterator.

impl<E: Entity, T: Copy> Copy for EntityPropertyTuple<E, T>