Struct ObjectRef

pub struct ObjectRef<'w, 's, 'a, T: Kind = Any>(/* private fields */);

Similar to EntityRef with the benefits of Object<T>.

Implementations

impl<'w, 's, 'a, T: Kind> ObjectRef<'w, 's, 'a, T>

pub unsafe fn from_base_unchecked(base: ObjectRef<'w, 's, 'a>) -> Self

Creates a new ObjectRef<T> from an ObjectRef<Any>.

This is semantically equivalent to an unsafe downcast.

Safety

Assumes base is of Kind T.

pub fn get<U: Component>(&self) -> Option<&U>

See EntityRef::get.

pub fn contains<U: Component>(&self) -> bool

See EntityRef::contains.

Trait Implementations

impl<T: Kind> Clone for ObjectRef<'_, '_, '_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Kind> ContainsInstance<T> for ObjectRef<'_, '_, '_, T>

fn instance(&self) -> Instance<T>

Returns the associated Instance<T>.

fn entity(&self) -> Entity

Returns the Entity of the associated Instance<T>.

impl<T: Kind> Debug for ObjectRef<'_, '_, '_, T>

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

Formats the value using the given formatter.

impl<T: Component> Deref for ObjectRef<'_, '_, '_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Kind> Display for ObjectRef<'_, '_, '_, T>

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

Formats the value using the given formatter.

impl<'w, 's, 'a, T: Kind> From<&ObjectRef<'w, 's, 'a, T>> for Object<'w, 's, 'a, T>

fn from(object: &ObjectRef<'w, 's, 'a, T>) -> Self

Converts to this type from the input type.

impl<T: Kind> From<ObjectRef<'_, '_, '_, T>> for Entity

fn from(object: ObjectRef<'_, '_, '_, T>) -> Self

Converts to this type from the input type.

impl<T: Kind> From<ObjectRef<'_, '_, '_, T>> for Instance<T>

fn from(object: ObjectRef<'_, '_, '_, T>) -> Self

Converts to this type from the input type.

impl<'w, 's, 'a, T: Kind> From<ObjectRef<'w, 's, 'a, T>> for Object<'w, 's, 'a, T>

fn from(object: ObjectRef<'w, 's, 'a, T>) -> Self

Converts to this type from the input type.

impl<T: Kind> ObjectHierarchy<T> for ObjectRef<'_, '_, '_, T>

fn parent(&self) -> Option<Self::Rebind<Any>>

Returns the parent of this object, if it exists.

fn children(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over all the children of this object.

fn ancestors(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over all ancestors of this object.

fn descendants_wide(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over all descendants of this object in breadth-first order.

fn descendants_deep(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over all descendants of this object in depth-first order.

fn find_by_path(&self, path: impl AsRef<str>) -> Option<Self::Rebind<Any>>

Attempts to find an object by its path, relative to this one.

fn root(&self) -> Self::Rebind<Any>

Returns the root of this object’s hierarchy.

fn is_root(&self) -> bool

Returns true if this object is the root of its hierarchy.

fn is_child(&self) -> bool

Returns true if this object is a child of another.

fn is_child_of(&self, parent: Entity) -> bool

Returns true if this object is a child of the given parent entity.

fn has_children(&self) -> bool

Returns true if this object has any children.

fn query_children<'a, Q: QueryData, F: QueryFilter>( &'a self, query: &'a Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

Queries the children of this object.

fn children_of_kind<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Returns an iterator over all children of this object which are of the given kind.

fn find_child_of_kind<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

Returns the first child of this object which is of the given kind, if it exists.

fn self_and_ancestors(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over this object and all its ancestors.

fn is_ancestor_of(&self, entity: Entity) -> bool

where Self::Rebind<Any>: ObjectHierarchy<Any>,

Returns true if this object is an ancestor of the given entity.

fn query_ancestors<'a, Q: QueryData, F: QueryFilter>( &'a self, query: &'a Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

Queries the ancestors of this object.

fn query_self_and_ancestors<'a, Q: QueryData, F: QueryFilter>( &'a self, query: &'a Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

Queries this object and its ancestors.

fn ancestors_of_kind<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Returns an iterator over all ancestors of this object which are of the given kind.

fn self_and_ancestors_of_kind<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Returns an iterator over this object and all its ancestors which are of the given kind.

fn find_ancestor_of_kind<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

Returns the first ancestor of this object which is of the given kind, if it exists.

fn self_and_descendants_wide(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over this object and all its descendants in breadth-first order.

fn self_and_descendants_deep(&self) -> impl Iterator<Item = Self::Rebind<Any>>

Returns an iterator over this object and all its descendants in depth-first order.

fn is_descendant_of(&self, entity: Entity) -> bool

where Self::Rebind<Any>: ObjectHierarchy<Any>,

Returns true if this object is a descendant of the given entity.

fn descendants_of_kind_wide<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Queries the descendants of this object in breadth-first order.

fn descendants_of_kind_deep<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Queries the descendants of this object in depth-first order.

fn self_and_descendants_of_kind_wide<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Queries this object and all its descendants in breadth-first order.

fn self_and_descendants_of_kind_deep<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

Queries this object and all its descendants in depth-first order.

fn query_descendants_wide<'a, 'q, Q: QueryData, F: QueryFilter>( &'a self, query: &'q Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'q, Q::ReadOnly>> + 'a

where 'q: 'a,

Queries the descendants of this object in breadth-first order.

fn query_descendants_deep<'a, 'q, Q: QueryData, F: QueryFilter>( &'a self, query: &'q Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'q, Q::ReadOnly>> + 'a

where 'q: 'a,

Queries the descendants of this object in depth-first order.

fn query_self_and_descendants_wide<'a, 'q, Q: QueryData, F: QueryFilter>( &'a self, query: &'q Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'q, Q::ReadOnly>> + 'a

where 'q: 'a,

Queries this object and all its descendants in breadth-first order.

fn query_self_and_descendants_deep<'a, 'q, Q: QueryData>( &'a self, query: &'q Query<'_, '_, Q>, ) -> impl Iterator<Item = QueryItem<'q, Q::ReadOnly>> + 'a

where 'q: 'a,

Queries this object and all its descendants in depth-first order.

fn find_descendant_of_kind_wide<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

Returns the first descendant of this object (breadth-first order) which is of the given kind, if it exists.

fn find_descendant_of_kind_deep<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

Returns the first descendant of this object (depth-first order) which is of the given kind, if it exists.

fn path(&self) -> String

Returns the path to this object.

impl<T: Kind> ObjectName for ObjectRef<'_, '_, '_, T>

fn name(&self) -> Option<&str>

Returns the Name of this object.

impl<'w, 's, 'a, T: Kind> ObjectRebind<T> for ObjectRef<'w, 's, 'a, T>

fn rebind_as<U: Kind>(&self, instance: Instance<U>) -> Self::Rebind<U>

Rebinds this object to an Instance of another Kind.

fn rebind(&self, instance: Instance<T>) -> Self::Rebind<T>

Rebinds this object to another Instance of the same Kind.

fn rebind_any(&self, entity: Entity) -> Self::Rebind<Any>

Rebinds this object to another Entity.

fn cast_into<U: Kind>(self) -> Self::Rebind<U>

where T: CastInto<U>,

Casts this object into another of a related Kind.

fn cast_into_any(self) -> Self::Rebind<Any>

Casts this object into an Object<Any>.

unsafe fn cast_into_unchecked<U: Kind>(self) -> Self::Rebind<U>

Casts this object into another of a different Kind.

impl<T: Kind> PartialEq for ObjectRef<'_, '_, '_, T>

fn eq(&self, other: &Self) -> 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<T: Kind> Copy for ObjectRef<'_, '_, '_, T>

impl<T: Kind> Eq for ObjectRef<'_, '_, '_, T>