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::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: std::marker::PhantomData<&'w &'s ()>
}
Implementations§
Source§impl<'w, 's, P> StaticSystemParam<'w, 's, P>where
P: SystemParam,
impl<'w, 's, P> StaticSystemParam<'w, 's, P>where
P: SystemParam,
Sourcepub fn into_inner(self) -> <P as SystemParam>::Item<'w, 's>
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,
impl<'w, 's, P> Deref for StaticSystemParam<'w, 's, P>where
P: SystemParam,
Source§impl<'w, 's, P> DerefMut for StaticSystemParam<'w, 's, P>where
P: SystemParam,
impl<'w, 's, P> DerefMut for StaticSystemParam<'w, 's, P>where
P: SystemParam,
Source§impl<P> SystemParam for StaticSystemParam<'_, '_, P>where
P: SystemParam + 'static,
impl<P> SystemParam for StaticSystemParam<'_, '_, P>where
P: SystemParam + 'static,
Source§type State = <P as SystemParam>::State
type State = <P as SystemParam>::State
Source§type Item<'world, 'state> = StaticSystemParam<'world, 'state, P>
type Item<'world, 'state> = StaticSystemParam<'world, 'state, P>
Self
, instantiated with new lifetimes. Read moreSource§fn init_state(
world: &mut World,
system_meta: &mut SystemMeta,
) -> <StaticSystemParam<'_, '_, P> as SystemParam>::State
fn init_state( world: &mut World, system_meta: &mut SystemMeta, ) -> <StaticSystemParam<'_, '_, P> as SystemParam>::State
World
access used by this SystemParam
and creates a new instance of this param’s State
.Source§unsafe fn new_archetype(
state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State,
archetype: &Archetype,
system_meta: &mut SystemMeta,
)
unsafe fn new_archetype( state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State, archetype: &Archetype, system_meta: &mut SystemMeta, )
Archetype
, registers the components accessed by this SystemParam
(if applicable).a Read moreSource§fn apply(
state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State,
system_meta: &SystemMeta,
world: &mut World,
)
fn apply( state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )
SystemParam
’s state.
This is used to apply Commands
during ApplyDeferred
.Source§fn queue(
state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut <StaticSystemParam<'_, '_, P> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
ApplyDeferred
.Source§unsafe fn validate_param(
state: &<StaticSystemParam<'_, '_, P> as SystemParam>::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'_>,
) -> Result<(), SystemParamValidationError>
unsafe fn validate_param( state: &<StaticSystemParam<'_, '_, P> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>
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>
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>
SystemParamFunction
. Read moreimpl<'w, 's, P> ReadOnlySystemParam for StaticSystemParam<'w, 's, P>where
P: ReadOnlySystemParam + 'static,
Auto Trait Implementations§
impl<'w, 's, P> Freeze for StaticSystemParam<'w, 's, P>
impl<'w, 's, P> RefUnwindSafe for StaticSystemParam<'w, 's, P>
impl<'w, 's, P> Send for StaticSystemParam<'w, 's, P>
impl<'w, 's, P> Sync for StaticSystemParam<'w, 's, P>
impl<'w, 's, P> Unpin for StaticSystemParam<'w, 's, P>
impl<'w, 's, P> UnwindSafe for StaticSystemParam<'w, 's, P>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more