Struct brood::Query

pub struct Query<V, F = None> { /* 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,
    },
    registry,
    Query,
    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()) {
    // Do something.
}

Implementations

impl<V, F> Query<V, F>

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<V, F> Clone for Query<V, F>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V, F> Default for Query<V, F>

fn default() -> Self

Returns the “default value” for a type.

impl<V, F> Copy for Query<V, F>