Struct ParamSetBuilder

pub struct ParamSetBuilder<T>(pub T);

A SystemParamBuilder for a ParamSet.

To build a ParamSet with a tuple of system parameters, pass a tuple of matching SystemParamBuilders. To build a ParamSet with a Vec of system parameters, pass a Vec of matching SystemParamBuilders.

Examples

let system = (ParamSetBuilder((
    QueryParamBuilder::new(|builder| {
        builder.with::<Enemy>();
    }),
    QueryParamBuilder::new(|builder| {
        builder.with::<Ally>();
    }),
    ParamBuilder,
)),)
    .build_state(&mut world)
    .build_system(buildable_system_with_tuple);

fn buildable_system_with_tuple(
    mut set: ParamSet<(Query<&mut Health>, Query<&mut Health>, &World)>,
) {
    // The first parameter is built from the first builder,
    // so this will iterate over enemies.
    for mut health in set.p0().iter_mut() {}
    // And the second parameter is built from the second builder,
    // so this will iterate over allies.
    for mut health in set.p1().iter_mut() {}
    // Parameters that don't need special building can use `ParamBuilder`.
    let entities = set.p2().entities();
}

let system = (ParamSetBuilder(vec![
    QueryParamBuilder::new_box(|builder| {
        builder.with::<Enemy>();
    }),
    QueryParamBuilder::new_box(|builder| {
        builder.with::<Ally>();
    }),
]),)
    .build_state(&mut world)
    .build_system(buildable_system_with_vec);

fn buildable_system_with_vec(mut set: ParamSet<Vec<Query<&mut Health>>>) {
    // As with tuples, the first parameter is built from the first builder,
    // so this will iterate over enemies.
    for mut health in set.get_mut(0).iter_mut() {}
    // And the second parameter is built from the second builder,
    // so this will iterate over allies.
    for mut health in set.get_mut(1).iter_mut() {}
    // You can iterate over the parameters either by index,
    // or using the `for_each` method.
    set.for_each(|mut query| for mut health in query.iter_mut() {});
}

Tuple Fields

0: T

Trait Implementations

impl<'w, 's, P0: SystemParam, B0: SystemParamBuilder<P0>> SystemParamBuilder<ParamSet<'w, 's, (P0,)>> for ParamSetBuilder<(B0,)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0,) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1)>> for ParamSetBuilder<(B0, B1)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>, B2: SystemParamBuilder<P2>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2)>> for ParamSetBuilder<(B0, B1, B2)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1, P2) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>, B2: SystemParamBuilder<P2>, B3: SystemParamBuilder<P3>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3)>> for ParamSetBuilder<(B0, B1, B2, B3)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1, P2, P3) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>, B2: SystemParamBuilder<P2>, B3: SystemParamBuilder<P3>, B4: SystemParamBuilder<P4>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4)>> for ParamSetBuilder<(B0, B1, B2, B3, B4)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1, P2, P3, P4) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>, B2: SystemParamBuilder<P2>, B3: SystemParamBuilder<P3>, B4: SystemParamBuilder<P4>, B5: SystemParamBuilder<P5>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>> for ParamSetBuilder<(B0, B1, B2, B3, B4, B5)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1, P2, P3, P4, P5) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>, B2: SystemParamBuilder<P2>, B3: SystemParamBuilder<P3>, B4: SystemParamBuilder<P4>, B5: SystemParamBuilder<P5>, B6: SystemParamBuilder<P6>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>> for ParamSetBuilder<(B0, B1, B2, B3, B4, B5, B6)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1, P2, P3, P4, P5, P6) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, B0: SystemParamBuilder<P0>, B1: SystemParamBuilder<P1>, B2: SystemParamBuilder<P2>, B3: SystemParamBuilder<P3>, B4: SystemParamBuilder<P4>, B5: SystemParamBuilder<P5>, B6: SystemParamBuilder<P6>, B7: SystemParamBuilder<P7>> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>> for ParamSetBuilder<(B0, B1, B2, B3, B4, B5, B6, B7)>

fn build( self, _world: &mut World, _system_meta: &mut SystemMeta, ) -> <(P0, P1, P2, P3, P4, P5, P6, P7) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.

impl<'w, 's, P: SystemParam, B: SystemParamBuilder<P>> SystemParamBuilder<ParamSet<'w, 's, Vec<P>>> for ParamSetBuilder<Vec<B>>

fn build( self, world: &mut World, system_meta: &mut SystemMeta, ) -> <Vec<P> as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.