pub struct StaticSystemParam<'w, 's, P>(/* private fields */)
where
    P: SystemParam;
Expand description

A helper for using system parameters in generic contexts

This type is a SystemParam adapter which always has Self::State::Item == Self (ignoring lifetimes for brevity), no matter the argument SystemParam (P) (other than that P must be 'static)

This makes it useful for having arbitrary SystemParam type arguments to function systems, or for generic types using the SystemParam derive:

use bevy_ecs::system::{SystemParam, StaticSystemParam};
#[derive(SystemParam)]
struct GenericParam<'w,'s, T: SystemParam + 'static> {
    field: StaticSystemParam<'w, 's, T>,
}
fn do_thing_generically<T: SystemParam + 'static>(t: StaticSystemParam<T>) {}

fn check_always_is_system<T: SystemParam + 'static>(){
    bevy_ecs::system::assert_is_system(do_thing_generically::<T>);
}

Note that in a real case you’d generally want additional bounds on P, for your use of the parameter to have a reason to be generic.

For example, using this would allow a type to be generic over whether a resource is accessed mutably or not, with impls being bounded on P: Deref<Target=MyType>, and P: DerefMut<Target=MyType> depending on whether the method requires mutable access or not.

The method which doesn’t use this type will not compile:


fn do_thing_generically<T: SystemParam + 'static>(t: T) {}

#[derive(SystemParam)]
struct GenericParam<'w, 's, T: SystemParam> {
    field: T,
    // Use the lifetimes in this type, or they will be unbound.
    phantom: core::marker::PhantomData<&'w &'s ()>
}

Implementations§

source§

impl<'w, 's, P> StaticSystemParam<'w, 's, P>
where P: SystemParam,

source

pub fn into_inner(self) -> <P as SystemParam>::Item<'w, 's>

Get the value of the parameter

Trait Implementations§

source§

impl<'w, 's, P> Deref for StaticSystemParam<'w, 's, P>
where P: SystemParam,

§

type Target = <P as SystemParam>::Item<'w, 's>

The resulting type after dereferencing.
source§

fn deref(&self) -> &<StaticSystemParam<'w, 's, P> as Deref>::Target

Dereferences the value.
source§

impl<'w, 's, P> DerefMut for StaticSystemParam<'w, 's, P>
where P: SystemParam,

source§

fn deref_mut(&mut self) -> &mut <StaticSystemParam<'w, 's, P> as Deref>::Target

Mutably dereferences the value.
source§

impl<P> SystemParam for StaticSystemParam<'_, '_, P>
where P: SystemParam + 'static,

§

type State = <P as SystemParam>::State

Used to store data which persists across invocations of a system.
§

type Item<'world, 'state> = StaticSystemParam<'world, 'state, P>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
source§

fn init_state( world: &mut World, system_meta: &mut SystemMeta ) -> <StaticSystemParam<'_, '_, P> as SystemParam>::State

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

fn new_archetype( state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).
source§

fn apply( state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.
source§

unsafe fn get_param<'world, 'state>( state: &'state mut <StaticSystemParam<'_, '_, P> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'world>, change_tick: Tick ) -> <StaticSystemParam<'_, '_, P> as SystemParam>::Item<'world, 'state>

Creates a parameter to be passed into a SystemParamFunction. Read more
source§

impl<'w, 's, P> ReadOnlySystemParam for StaticSystemParam<'w, 's, P>
where P: ReadOnlySystemParam + 'static,

Auto Trait Implementations§

§

impl<'w, 's, P> RefUnwindSafe for StaticSystemParam<'w, 's, P>
where <P as SystemParam>::Item<'w, 's>: RefUnwindSafe,

§

impl<'w, 's, P> Send for StaticSystemParam<'w, 's, P>
where <P as SystemParam>::Item<'w, 's>: Send,

§

impl<'w, 's, P> Sync for StaticSystemParam<'w, 's, P>
where <P as SystemParam>::Item<'w, 's>: Sync,

§

impl<'w, 's, P> Unpin for StaticSystemParam<'w, 's, P>
where <P as SystemParam>::Item<'w, 's>: Unpin,

§

impl<'w, 's, P> UnwindSafe for StaticSystemParam<'w, 's, P>
where <P as SystemParam>::Item<'w, 's>: UnwindSafe,

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

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

source§

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

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

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

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

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

source§

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

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> Instrument for T

source§

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

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

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.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

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

§

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>,

§

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

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

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

source§

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

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,