Struct flax::EntityRef

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

Borrow all the components of an entity at once.

This is handy to borrow an entity and perform multiple operations on it without mentioning the id and performing re-lookups.

Implementations

impl<'a> EntityRef<'a>

pub fn get<T: ComponentValue>( &self, component: Component<T> ) -> Result<AtomicRef<'a, T>, MissingComponent>

Access a component

pub fn get_mut<T: ComponentValue>( &self, component: Component<T> ) -> Result<RefMut<'a, T>, MissingComponent>

Access a component mutably

pub fn get_copy<T: ComponentValue + Copy>( &self, component: Component<T> ) -> Result<T, MissingComponent>

Shorthand to copy and not use a borrowing references

pub fn has<T: ComponentValue>(&self, component: Component<T>) -> bool

Check if the entity currently has the specified component without borrowing.

pub fn update<T: ComponentValue, U>( &self, component: Component<T>, f: impl FnOnce(&mut T) -> U ) -> Option<U>

Updates a component in place

pub fn update_dedup<T: ComponentValue + PartialEq>( &self, component: Component<T>, value: T ) -> Option<()>

Updates a component in place

pub fn query<'q, Q: Fetch<'q>>(&'q self, query: &'q Q) -> QueryOne<'q, Q>

Perform a query on the entity

pub fn try_get<T: ComponentValue>( &self, component: Component<T> ) -> Result<Option<AtomicRef<'_, T>>, BorrowError>

Attempt concurrently access a component mutably using and fail if the component is already borrowed

pub fn try_get_mut<T: ComponentValue>( &self, component: Component<T> ) -> Result<Option<RefMut<'_, T>>, BorrowMutError>

Attempt to concurrently access a component mutably using and fail if the component is already borrowed

pub fn relations<T: ComponentValue>( &self, relation: impl RelationExt<T> ) -> RelationIter<'a, T>

Returns all relations to other entities of the specified kind

pub fn relations_mut<T: ComponentValue>( &self, relation: impl RelationExt<T> ) -> RelationIterMut<'a, T>

Returns all relations to other entities of the specified kind

pub fn id(&self) -> Entity

Returns the entity id

Trait Implementations

impl<'a> Clone for EntityRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EntityRef<'a>

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

Formats the value using the given formatter.

impl Display for EntityRef<'_>

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

Formats the value using the given formatter.

impl<'a> Copy for EntityRef<'a>