Object

moonshine_core::object::prelude

Struct Object 

Source 
pub struct Object<'w, 's, 'a, T = Any>
where
    T: Kind,
{ /* private fields */ }
Expand description

Represents an Entity of Kind T with hierarchy and name information.

Implementations§

Source§

impl<'w, 's, 'a, T> Object<'w, 's, 'a, T>
where T: Kind,

Source

pub unsafe fn from_any_unchecked( object: Object<'w, 's, 'a>, ) -> Object<'w, 's, 'a, T>

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

This is semantically equivalent to an unsafe downcast.

§Safety

Assumes base is of Kind T.

Source

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

Returns the object as an Instance<T>.

Source

pub fn entity(&self) -> Entity

Returns the object as an Entity.

Source§

impl<'w, 's, 'a, T> Object<'w, 's, 'a, T>
where T: Component,

Source

pub fn from_any( world: &World, object: Object<'w, 's, 'a>, ) -> Option<Object<'w, 's, 'a, T>>

Creates a new Object<T> from an Object<Any> if it is a valid instance of T.

Trait Implementations§

Source§

impl<T> Clone for Object<'_, '_, '_, T>
where T: Kind,

Source§

fn clone(&self) -> Object<'_, '_, '_, T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> ContainsInstance<T> for Object<'_, '_, '_, T>
where T: Kind,

Source§

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

Returns the associated Instance<T>.
Source§

fn entity(&self) -> Entity

Returns the Entity of the associated Instance<T>.
Source§

impl<T> Debug for Object<'_, '_, '_, T>
where T: Kind,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Display for Object<'_, '_, '_, T>
where T: Kind,

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from(object: Object<'_, '_, '_, T>) -> Entity

Converts to this type from the input type.
Source§

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

Source§

fn from(object: Object<'_, '_, '_, T>) -> Instance<T>

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl<T> ObjectHierarchy<T> for Object<'_, '_, '_, T>
where T: Kind,

Source§

fn parent( &self, ) -> Option<<Object<'_, '_, '_, T> as ObjectRebind<T>>::Rebind<Any>>

Returns the parent of this object, if it exists.
Source§

fn children( &self, ) -> impl Iterator<Item = <Object<'_, '_, '_, T> as ObjectRebind<T>>::Rebind<Any>>

Iterates over all children of this object.
Source§

fn ancestors( &self, ) -> impl Iterator<Item = <Object<'_, '_, '_, T> as ObjectRebind<T>>::Rebind<Any>>

Iterates over all ancestors of this object.
Source§

fn descendants_wide( &self, ) -> impl Iterator<Item = <Object<'_, '_, '_, T> as ObjectRebind<T>>::Rebind<Any>>

Iterates over all descendants of this object in breadth-first order.
Source§

fn descendants_deep( &self, ) -> impl Iterator<Item = <Object<'_, '_, '_, T> as ObjectRebind<T>>::Rebind<Any>>

Iterates over all descendants of this object in depth-first order.
Source§

fn find_by_path( &self, path: impl AsRef<str>, ) -> Option<<Object<'_, '_, '_, T> as ObjectRebind<T>>::Rebind<Any>>

Attempts to find an object by its path, relative to this one. Read more
Source§

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

Returns the root of this object’s hierarchy.
Source§

fn is_root(&self) -> bool

Returns true if this object is the root of its hierarchy.
Returns true if this object has the same root as another.
Source§

fn is_child(&self) -> bool

Returns true if this object is a child of another.
Source§

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

Returns true if this object is a child of the given Entity.
Source§

fn has_children(&self) -> bool

Returns true if this object has any children.
Source§

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

Iterates over all children of this object which match the given Query.
Source§

fn children_of_kind<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>> + 'a
where U: Kind,

Iterates over all children of this object which match the given Kind.
Source§

fn find_child_of_kind<'w, 's, 'a, U>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>
where U: Kind,

Returns the first child of this object which matches the given kind, if it exists.
Source§

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

Iterates over this object, followed by all of its ancestors.
Source§

fn is_ancestor_of<U>(&self, other: &impl ObjectHierarchy<U>) -> bool
where U: Kind, Self::Rebind<Any>: ObjectHierarchy,

Returns true if this object is an ancestor of another.
Source§

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

Iterates over all ancestors of this object which match the given Query.
Source§

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

Iterates over this object, followed by all its ancestors which match the given Query.
Source§

fn ancestors_of_kind<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>
where U: Kind,

Iterates over all ancestors of this object which match the given Kind.
Source§

fn self_and_ancestors_of_kind<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>
where U: Kind,

Iterates over this object, followed by all its ancestors which match the given Kind.
Source§

fn find_ancestor_of_kind<'w, 's, 'a, U>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>
where U: Kind,

Returns the first ancestor of this object which matches the given Kind, if it exists.
Source§

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

Iterates over this object and all its descendants in breadth-first order.
Source§

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

Iterates over this object and all its descendants in depth-first order.
Source§

fn is_descendant_of(&self, entity: Entity) -> bool
where Self::Rebind<Any>: ObjectHierarchy,

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

fn descendants_of_kind_wide<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>
where U: Kind,

Iterates over all descendants of this object which match the given Kind in breadth-first order.
Source§

fn descendants_of_kind_deep<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>
where U: Kind,

Iterates over all descendants of this object which match the given Kind in depth-first order.
Source§

fn self_and_descendants_of_kind_wide<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>
where U: Kind,

Iterates over this object, followed by all its descendants which match the given Kind in breadth-first order.
Source§

fn self_and_descendants_of_kind_deep<'w, 's, 'a, U>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>
where U: Kind,

Iterates over this object, followed by all its descendants which match the given Kind in depth-first order.
Source§

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

Iterates over all descendants of this object which match the given Query in breadth-first order.
Source§

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

Iterates over all descendants of this object which match the given Kind in depth-first order.
Source§

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

Iterates over this object, followed by all its descendants which match the given Query in breadth-first order.
Source§

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

Iterates over this object, followed by all its descendants which match the given Query in depth-first order.
Source§

fn find_descendant_of_kind_wide<'w, 's, 'a, U>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>
where U: Kind,

Returns the first descendant of this object (breadth-first order) which matches the given Kind, if it exists.
Source§

fn find_descendant_of_kind_deep<'w, 's, 'a, U>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>
where U: Kind,

Returns the first descendant of this object (depth-first order) which matches the given Kind, if it exists.
Source§

fn path(&self) -> String

Returns the path to this object.
Source§

impl<T> ObjectName for Object<'_, '_, '_, T>
where T: Kind,

Source§

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

Returns the Name of this object. Read more
Source§

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

Source§

unsafe fn rebind_as<U>( &self, instance: Instance<U>, ) -> <Object<'w, 's, 'a, T> as ObjectRebind<T>>::Rebind<U>
where U: Kind,

Rebinds this object to an Instance of another Kind. Read more
Source§

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

Rebinds this object to another Instance of the same Kind. Read more
Source§

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

Rebinds this object to another Entity. Read more
Source§

fn cast_into<U>(self) -> Self::Rebind<U>
where U: Kind, T: CastInto<U>,

Casts this object into another of a related Kind. Read more
Source§

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

Casts this object into an Object<Any>. Read more
Source§

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

Casts this object into another of a different Kind. Read more
Source§

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

Returns this object as an Object<Any>.
Source§

impl<T> ObjectTags for Object<'_, '_, '_, T>
where T: Kind,

Source§

fn tags(&self) -> &Tags

Returns the Tags of this Object. Read more
Source§

impl<T> PartialEq<Entity> for Object<'_, '_, '_, T>
where T: Kind,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> PartialEq<Instance<T>> for Object<'_, '_, '_, T>
where T: Kind,

Source§

fn eq(&self, other: &Instance<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> PartialEq<Object<'_, '_, '_, T>> for Entity
where T: Kind,

Source§

fn eq(&self, other: &Object<'_, '_, '_, T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> PartialEq<Object<'_, '_, '_, T>> for Instance<T>
where T: Kind,

Source§

fn eq(&self, other: &Object<'_, '_, '_, T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T, U> PartialEq<Object<'_, '_, '_, U>> for Object<'_, '_, '_, T>
where T: Kind, U: Kind,

Source§

fn eq(&self, other: &Object<'_, '_, '_, U>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> Copy for Object<'_, '_, '_, T>
where T: Kind,

Source§

impl<T> Eq for Object<'_, '_, '_, T>
where T: Kind,

Auto Trait Implementations§

§

impl<'w, 's, 'a, T> Freeze for Object<'w, 's, 'a, T>

§

impl<'w, 's, 'a, T = Any> !RefUnwindSafe for Object<'w, 's, 'a, T>

§

impl<'w, 's, 'a, T> Send for Object<'w, 's, 'a, T>

§

impl<'w, 's, 'a, T> Sync for Object<'w, 's, 'a, T>

§

impl<'w, 's, 'a, T> Unpin for Object<'w, 's, 'a, T>
where T: Unpin,

§

impl<'w, 's, 'a, T = Any> !UnwindSafe for Object<'w, 's, 'a, T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynEq for T
where T: Any + Eq,

Source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> Static for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

Source§

impl<T> WasmNotSync for T
where T: Sync,