Skip to main content

With

Struct With 

Source
pub struct With<T>(/* private fields */);
Expand description

Query filter that matches entities that have a component.

With<T> is a filter, not a data fetch. It filters entities to only those that have component T, but doesn’t actually retrieve the component data.

Use With<T> when you need to ensure an entity has a component but don’t need to access its data.

§Example

use goud_engine::ecs::{Component, World};
use goud_engine::ecs::query::With;

struct Player;
impl Component for Player {}

struct Health(f32);
impl Component for Health {}

// Query for Health, but only for entities that also have Player
// (Health, With<Player>) - fetches Health data, filters by Player

Implementations§

Source§

impl<T> With<T>

Source

pub fn new() -> Self

Creates a new With filter.

Trait Implementations§

Source§

impl<T: Clone> Clone for With<T>

Source§

fn clone(&self) -> With<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: Debug> Debug for With<T>

Source§

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

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

impl<T: Default> Default for With<T>

Source§

fn default() -> With<T>

Returns the “default value” for a type. Read more
Source§

impl<T: Component> WorldQuery for With<T>

Source§

type Item<'w> = ()

The type of data this query fetches. Read more
Source§

type State = ComponentId

The cached state for this query. Read more
Source§

fn init_state(_world: &World) -> Self::State

Initializes the query state from the world. Read more
Source§

fn component_access(_state: &Self::State) -> BTreeSet<ComponentId>

Returns the set of component IDs this query reads. Read more
Source§

fn matches_archetype(state: &Self::State, archetype: &Archetype) -> bool

Checks whether this query matches the given archetype. Read more
Source§

fn fetch<'w>( state: &Self::State, world: &'w World, entity: Entity, ) -> Option<Self::Item<'w>>

Fetches data for a specific entity from the world. Read more
Source§

fn fetch_mut<'w>( state: &Self::State, world: &'w mut World, entity: Entity, ) -> Option<Self::Item<'w>>

Fetches data for a specific entity from a mutable world reference. Read more
Source§

impl<T: Copy> Copy for With<T>

Source§

impl<T: Component> ReadOnlyWorldQuery for With<T>

Auto Trait Implementations§

§

impl<T> Freeze for With<T>

§

impl<T> RefUnwindSafe for With<T>
where T: RefUnwindSafe,

§

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

§

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

§

impl<T> Unpin for With<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for With<T>

§

impl<T> UnwindSafe for With<T>
where T: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

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

Source§

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

Source§

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