Struct Query 

pub struct Query<Views, Filters = None, ResourceViews = Null, EntryViews = Null> { /* private fields */ }

Defines a query to be run over a world.

This defines either a regular or parallel query (parallel requires the rayon feature to be enabled). It is essentially a marker type, simply providing the types to the calls to query() to make the API as simple to use as possible.

Example

use brood::{
    entity,
    query::{
        filter,
        result,
        Views,
    },
    Query,
    Registry,
    World,
};

// Define components.
struct Foo(u32);
struct Bar(bool);
struct Baz(f64);

type Registry = Registry!(Foo, Bar, Baz);

let mut world = World::<Registry>::new();
world.insert(entity!(Foo(42), Bar(true), Baz(1.5)));

for result!(foo, bar) in world
    .query(Query::<Views!(&mut Foo, &Bar), filter::Has<Baz>>::new())
    .iter
{
    // Do something.
}

Implementations

impl<Views, Filters, ResourceViews, EntryViews> Query<Views, Filters, ResourceViews, EntryViews>

pub fn new() -> Self

Creates a new Query.

When creating a query, you must specify the views type V, and can optionally specify the filter type F. If no filter is specified, the default filter, filter::None, will be used.

Trait Implementations

impl<Views, Filters, ResourceViews, EntryViews> Clone for Query<Views, Filters, ResourceViews, EntryViews>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Views, Filters, ResourceViews, EntryViews> Debug for Query<Views, Filters, ResourceViews, EntryViews>

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

Formats the value using the given formatter.

impl<Views, Filters, ResourceViews, EntryViews> Default for Query<Views, Filters, ResourceViews, EntryViews>

fn default() -> Self

Returns the “default value” for a type.

impl<Views, Filters, ResourceViews, EntryViews> PartialEq for Query<Views, Filters, ResourceViews, EntryViews>

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<Views, Filters, ResourceViews, EntryViews> Copy for Query<Views, Filters, ResourceViews, EntryViews>

impl<Views, Filters, ResourceViews, EntryViews> Eq for Query<Views, Filters, ResourceViews, EntryViews>