Struct flatbox_ecs::Added

pub struct Added<T>(/* private fields */);

Expand description

Query that retrieves added state of type T component.

It is your responsibility to clear trackers with World::clear_trackers() at the start of the frame (or any other suitable moment).

§Example

let mut world = World::new();
let e = world.spawn((123,));
for (_id, (value, value_add)) in world.query::<(&i32, Added<i32>)>().iter() {
  assert_eq!(*value, 123);
  assert_eq!(value_add, true);
}
world.clear_trackers();
for (_id, value_add) in world.query::<Added<i32>>().iter() {
  assert_eq!(value_add, false);
}

Trait Implementations§

impl<T> Query for Added<T>
where T: Component,

type Item<'a> = bool

Type of results yielded by the query Read more

Auto Trait Implementations§

impl<T> Freeze for Added<T>

impl<T> RefUnwindSafe for Added<T>

impl<T> Send for Added<T>

impl<T> Sync for Added<T>

impl<T> Unpin for Added<T>

impl<T> UnwindSafe for Added<T>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

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

fn type_name(&self) -> &'static str

Gets the type name of self

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<'a, Q> ComponentBorrow for Q
where Q: Query,

fn borrows() -> SmallVec<[Access; 8]>

Returns a list of all component accesses

fn has_dynamic(id: TypeId, exclusive: bool) -> bool

Returns true if id exists in Self

fn has<U>() -> bool
where U: IntoAccess,

Returns true if U exists in Self

impl<T> Downcast for T
where T: AsAny + ?Sized,

fn is<T>(&self) -> bool
where T: AsAny,

Returns true if the boxed type is the same as T. Read more

fn downcast_ref<T>(&self) -> Option<&T>
where T: AsAny,

Forward to the method defined on the type Any.

fn downcast_mut<T>(&mut self) -> Option<&mut T>
where T: AsAny,

Forward to the method defined on the type Any.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<'a, Q> Subset for Q
where Q: Query,

fn is_subset<U>() -> bool
where U: ComponentBorrow,

Returns true if U is a subset of Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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