Struct rfw::ecs::system::Query[−][src]

pub struct Query<'w, Q, F = ()> where
    F: WorldQuery,
    Q: WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch,  { /* fields omitted */ }

Expand description

Provides scoped access to a World according to a given WorldQuery and query filter

Implementations

[src]

impl<'w, Q, F> Query<'w, Q, F> where
    F: WorldQuery,
    Q: WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch,

[src]

pub fn iter(&self) -> QueryIter<'_, '_, Q, F>ⓘNotable traits for QueryIter<'w, 's, Q, F>
impl<'w, 's, Q, F> Iterator for QueryIter<'w, 's, Q, F> where
    F: WorldQuery,
    Q: WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch,     type Item = <<Q as WorldQuery>::Fetch as Fetch<'w>>::Item; where
    <Q as WorldQuery>::Fetch: ReadOnlyFetch,

Iterates over the query results. This can only be called for read-only queries

[src]

pub fn iter_mut(&mut self) -> QueryIter<'_, '_, Q, F>ⓘNotable traits for QueryIter<'w, 's, Q, F>
impl<'w, 's, Q, F> Iterator for QueryIter<'w, 's, Q, F> where
    F: WorldQuery,
    Q: WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch,     type Item = <<Q as WorldQuery>::Fetch as Fetch<'w>>::Item;

Iterates over the query results

[src]

pub unsafe fn iter_unsafe(&self) -> QueryIter<'_, '_, Q, F>ⓘNotable traits for QueryIter<'w, 's, Q, F>
impl<'w, 's, Q, F> Iterator for QueryIter<'w, 's, Q, F> where
    F: WorldQuery,
    Q: WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch,     type Item = <<Q as WorldQuery>::Fetch as Fetch<'w>>::Item;

Iterates over the query results

Safety

This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component

[src]

pub fn for_each(
    &self, 
    f: impl FnMut(<<Q as WorldQuery>::Fetch as Fetch<'w>>::Item)
) where
    <Q as WorldQuery>::Fetch: ReadOnlyFetch,

Runs f on each query result. This is faster than the equivalent iter() method, but cannot be chained like a normal iterator. This can only be called for read-only queries

[src]

pub fn for_each_mut(
    &self, 
    f: impl FnMut(<<Q as WorldQuery>::Fetch as Fetch<'w>>::Item)
)

Runs f on each query result. This is faster than the equivalent iter() method, but cannot be chained like a normal iterator.

[src]

pub fn par_for_each(
    &self, 
    task_pool: &TaskPool, 
    batch_size: usize, 
    f: impl Fn(<<Q as WorldQuery>::Fetch as Fetch<'w>>::Item) + Send + Sync + Clone
) where
    <Q as WorldQuery>::Fetch: ReadOnlyFetch,

Runs f on each query result in parallel using the given task pool.

[src]

pub fn par_for_each_mut(
    &mut self, 
    task_pool: &TaskPool, 
    batch_size: usize, 
    f: impl Fn(<<Q as WorldQuery>::Fetch as Fetch<'w>>::Item) + Send + Sync + Clone
)

Runs f on each query result in parallel using the given task pool.

[src]

pub fn get(
    &self, 
    entity: Entity
) -> Result<<<Q as WorldQuery>::Fetch as Fetch<'_>>::Item, QueryEntityError> where
    <Q as WorldQuery>::Fetch: ReadOnlyFetch,

Gets the query result for the given entity

[src]

pub fn get_mut(
    &mut self, 
    entity: Entity
) -> Result<<<Q as WorldQuery>::Fetch as Fetch<'_>>::Item, QueryEntityError>

Gets the query result for the given entity

[src]

pub unsafe fn get_unchecked(
    &self, 
    entity: Entity
) -> Result<<<Q as WorldQuery>::Fetch as Fetch<'_>>::Item, QueryEntityError>

Gets the query result for the given entity

Safety

This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component

[src]

pub fn get_component<T>(
    &self, 
    entity: Entity
) -> Result<&T, QueryComponentError> where
    T: Component,

Gets a reference to the entity’s component of the given type. This will fail if the entity does not have the given component type or if the given component type does not match this query.

[src]

pub fn get_component_mut<T>(
    &mut self, 
    entity: Entity
) -> Result<Mut<'_, T>, QueryComponentError> where
    T: Component,

Gets a mutable reference to the entity’s component of the given type. This will fail if the entity does not have the given component type or if the given component type does not match this query.

[src]

pub unsafe fn get_component_unchecked_mut<T>(
    &self, 
    entity: Entity
) -> Result<Mut<'_, T>, QueryComponentError> where
    T: Component,

Gets a mutable reference to the entity’s component of the given type. This will fail if the entity does not have the given component type or the component does not match the query.

Safety

This allows aliased mutability. You must make sure this call does not result in multiple mutable references to the same component

[src]

pub fn single(
    &self
) -> Result<<<Q as WorldQuery>::Fetch as Fetch<'_>>::Item, QuerySingleError> where
    <Q as WorldQuery>::Fetch: ReadOnlyFetch,

[src]

pub fn single_mut(
    &mut self
) -> Result<<<Q as WorldQuery>::Fetch as Fetch<'_>>::Item, QuerySingleError>

See Query::single

Trait Implementations

[src]

impl<'a, Q, F> SystemParam for Query<'a, Q, F> where
    F: 'static + WorldQuery,
    Q: 'static + WorldQuery,
    <F as WorldQuery>::Fetch: FilterFetch,

type Fetch = QueryState<Q, F>

Auto Trait Implementations

impl<'w, Q, F = ()> !RefUnwindSafe for Query<'w, Q, F>

impl<'w, Q, F> Send for Query<'w, Q, F>

impl<'w, Q, F> Sync for Query<'w, Q, F>

impl<'w, Q, F> Unpin for Query<'w, Q, F>

impl<'w, Q, F = ()> !UnwindSafe for Query<'w, Q, F>

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
    Self: Into<T>,

Converts self into T using Into<T>. Read more

[src]

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

[src]

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

[src]

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

[src]

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

[src]

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

[src]

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
    Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self> where
    Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
    Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
    Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
    Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self> where
    Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
    Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
    Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

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

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

[src]

fn in_current_span(self) -> Instrumented<Self>

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

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
    R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
    R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
    Self: Borrow<B>,
    B: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
    &'a mut self, 
    func: impl FnOnce(&'a mut B) -> R
) -> R where
    Self: BorrowMut<B>,
    B: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
    Self: AsRef<U>,
    R: 'a,
    U: 'a + ?Sized,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
    Self: AsMut<U>,
    R: 'a,
    U: 'a + ?Sized,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
    Self: Deref<Target = T>,
    T: 'a + ?Sized,
    R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
    &'a mut self, 
    func: impl FnOnce(&'a mut T) -> R
) -> R where
    Self: DerefMut<Target = T> + Deref,
    T: 'a + ?Sized,
    R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

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

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
    Self: Borrow<B>,
    B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
    Self: BorrowMut<B>,
    B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
    Self: AsRef<R>,
    R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
    Self: AsMut<R>,
    R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
    Self: Deref<Target = T>,
    T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
    Self: DerefMut<Target = T> + Deref,
    T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
    Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

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

[src]

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

[src]

impl<T> Resource for T where
    T: 'static,