Struct flatbox_ecs::With

pub struct With<Q, R>(/* private fields */);

Expand description

Query transformer skipping entities that do not satisfy another query

See also QueryBorrow::with.

§Example

let mut world = World::new();
let a = world.spawn((123, true, "abc"));
let b = world.spawn((456, false));
let c = world.spawn((42, "def"));
let entities = world.query::<With<&i32, &bool>>()
    .iter()
    .map(|(e, &i)| (e, i))
    .collect::<Vec<_>>();
assert_eq!(entities.len(), 2);
assert!(entities.contains(&(a, 123)));
assert!(entities.contains(&(b, 456)));

Trait Implementations§

impl<Q, R> Query for With<Q, R>
where Q: Query, R: Query,

type Item<'q> = <Q as Query>::Item<'q>

Type of results yielded by the query Read more

impl<Q, R> QueryShared for With<Q, R>
where Q: QueryShared,

Auto Trait Implementations§

impl<Q, R> Freeze for With<Q, R>

impl<Q, R> RefUnwindSafe for With<Q, R>
where Q: RefUnwindSafe,

impl<Q, R> Send for With<Q, R>
where Q: Send,

impl<Q, R> Sync for With<Q, R>
where Q: Sync,

impl<Q, R> Unpin for With<Q, R>
where Q: Unpin,

impl<Q, R> UnwindSafe for With<Q, R>
where Q: UnwindSafe,

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,