Struct valence::ecs::system::SystemBuilder

pub struct SystemBuilder<'w, T = ()>
where
    T: SystemParam,
{ /* private fields */ }
Expand description

Builder struct used to construct state for SystemParam passed to a system.


fn my_system(res: Res<R>, query: Query<&A>, param: MyParam) {
    // ...
}

// Create a builder from the world, helper methods exist to add `SystemParam`,
// alternatively use `.param::<T>()` for any other `SystemParam` types.
let system = SystemBuilder::<()>::new(&mut world)
    .resource::<R>()
    .query::<&A>()
    .param::<MyParam>()
    .build(my_system);

// Parameters that the builder is initialised with will appear first in the arguments.
let system = SystemBuilder::<(Res<R>, Query<&A>)>::new(&mut world)
    .param::<MyParam>()
    .build(my_system);

// Parameters that implement `BuildableSystemParam` can use `.builder::<T>()` to build in place.
let system = SystemBuilder::<()>::new(&mut world)
    .resource::<R>()
    .builder::<Query<&A>>(|builder| { builder.with::<B>(); })
    .param::<MyParam>()
    .build(my_system);

world.run_system_once(system);

Implementations§

§

impl<'w, T> SystemBuilder<'w, T>
where T: SystemParam,

pub fn new(world: &'w mut World) -> SystemBuilder<'w, T>

Construct a new builder with the default state for T

pub fn build<F, Marker>(self, func: F) -> FunctionSystem<Marker, F>
where F: SystemParamFunction<Marker, Param = T>,

Construct the a system with the built params

pub fn state(self) -> SystemState<T>

Return the constructed SystemState

§

impl<'w> SystemBuilder<'w>

pub fn param<T>(self) -> SystemBuilder<'w, (T,)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>(self) -> SystemBuilder<'w, (Res<'static, T>,)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>(self) -> SystemBuilder<'w, (ResMut<'static, T>,)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>(self) -> SystemBuilder<'w, (Local<'static, T>,)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>(self) -> SystemBuilder<'w, (Query<'static, 'static, D>,)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (Query<'static, 'static, D, F>,)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (T,)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0> SystemBuilder<'w, (P0,)>
where P0: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>(self) -> SystemBuilder<'w, (P0, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>(self) -> SystemBuilder<'w, (P0, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>(self) -> SystemBuilder<'w, (P0, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>(self) -> SystemBuilder<'w, (P0, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1> SystemBuilder<'w, (P0, P1)>
where P0: SystemParam, P1: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>(self) -> SystemBuilder<'w, (P0, P1, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>(self) -> SystemBuilder<'w, (P0, P1, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>(self) -> SystemBuilder<'w, (P0, P1, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>(self) -> SystemBuilder<'w, (P0, P1, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2> SystemBuilder<'w, (P0, P1, P2)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, P2, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>(self) -> SystemBuilder<'w, (P0, P1, P2, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>(self) -> SystemBuilder<'w, (P0, P1, P2, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3> SystemBuilder<'w, (P0, P1, P2, P3)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4> SystemBuilder<'w, (P0, P1, P2, P3, P4)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam,

pub fn param<T>(self) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam, P9: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam, P9: SystemParam, P10: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam, P9: SystemParam, P10: SystemParam, P11: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam, P9: SystemParam, P10: SystemParam, P11: SystemParam, P12: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam, P9: SystemParam, P10: SystemParam, P11: SystemParam, P12: SystemParam, P13: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

§

impl<'w, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam, P3: SystemParam, P4: SystemParam, P5: SystemParam, P6: SystemParam, P7: SystemParam, P8: SystemParam, P9: SystemParam, P10: SystemParam, P11: SystemParam, P12: SystemParam, P13: SystemParam, P14: SystemParam,

pub fn param<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, T)>
where T: SystemParam,

Add T as a parameter built from the world

pub fn resource<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, Res<'static, T>)>
where T: Resource,

Helper method for reading a Resource as a param, equivalent to .param::<Res<T>>()

pub fn resource_mut<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, ResMut<'static, T>)>
where T: Resource,

Helper method for mutably accessing a Resource as a param, equivalent to .param::<ResMut<T>>()

pub fn local<T>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, Local<'static, T>)>
where T: Send + FromWorld,

Helper method for adding a Local as a param, equivalent to .param::<Local<T>>()

pub fn query<D>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, Query<'static, 'static, D>)>
where D: QueryData,

Helper method for adding a Query as a param, equivalent to .param::<Query<D>>()

pub fn query_filtered<D, F>( self, ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, Query<'static, 'static, D, F>)>
where D: QueryData, F: QueryFilter,

Helper method for adding a filtered Query as a param, equivalent to .param::<Query<D, F>>()

pub fn builder<T>( self, func: impl FnOnce(&mut <T as BuildableSystemParam>::Builder<'_>), ) -> SystemBuilder<'w, (P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, P10, P11, P12, P13, P14, T)>
where T: BuildableSystemParam,

Add T as a parameter built with the given function

Auto Trait Implementations§

§

impl<'w, T> Freeze for SystemBuilder<'w, T>
where <T as SystemParam>::State: Freeze,

§

impl<'w, T = ()> !RefUnwindSafe for SystemBuilder<'w, T>

§

impl<'w, T> Send for SystemBuilder<'w, T>

§

impl<'w, T> Sync for SystemBuilder<'w, T>

§

impl<'w, T> Unpin for SystemBuilder<'w, T>
where <T as SystemParam>::State: Unpin,

§

impl<'w, T = ()> !UnwindSafe for SystemBuilder<'w, T>

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
§

impl<T> Conv for T

§

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

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

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

§

fn into_any(self: Box<T>) -> Box<dyn Any>

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.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

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

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.
§

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.
§

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

§

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

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

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.
§

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

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

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

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

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.
§

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

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

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

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

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

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

§

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

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>, U: 'a + ?Sized, R: 'a,

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>, U: 'a + ?Sized, R: 'a,

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

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.
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
§

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<B> 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<B> 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.
§

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.
§

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.
§

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.
§

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.
§

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.
§

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.
§

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
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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