pub struct ExclusiveFunctionSystem<Marker, Out, F>where
F: ExclusiveSystemParamFunction<Marker>,{ /* private fields */ }
Expand description
A function system that runs with exclusive World
access.
You get this by calling IntoSystem::into_system
on a function that only accepts
ExclusiveSystemParam
s.
ExclusiveFunctionSystem
must be .initialized
before they can be run.
Implementations§
Source§impl<Marker, Out, F> ExclusiveFunctionSystem<Marker, Out, F>where
F: ExclusiveSystemParamFunction<Marker>,
impl<Marker, Out, F> ExclusiveFunctionSystem<Marker, Out, F>where
F: ExclusiveSystemParamFunction<Marker>,
Trait Implementations§
Source§impl<Marker, Out, F> System for ExclusiveFunctionSystem<Marker, Out, F>where
Marker: 'static,
Out: 'static,
F::Out: IntoResult<Out>,
F: ExclusiveSystemParamFunction<Marker>,
impl<Marker, Out, F> System for ExclusiveFunctionSystem<Marker, Out, F>where
Marker: 'static,
Out: 'static,
F::Out: IntoResult<Out>,
F: ExclusiveSystemParamFunction<Marker>,
Source§type In = <F as ExclusiveSystemParamFunction<Marker>>::In
type In = <F as ExclusiveSystemParamFunction<Marker>>::In
The system’s input.
Source§fn flags(&self) -> SystemStateFlags
fn flags(&self) -> SystemStateFlags
Returns the
SystemStateFlags
of the system.Source§unsafe fn run_unsafe(
&mut self,
input: SystemIn<'_, Self>,
world: UnsafeWorldCell<'_>,
) -> Result<Self::Out, RunSystemError>
unsafe fn run_unsafe( &mut self, input: SystemIn<'_, Self>, world: UnsafeWorldCell<'_>, ) -> Result<Self::Out, RunSystemError>
Runs the system with the given input in the world. Unlike
System::run
, this function
can be called in parallel with other systems and may break Rust’s aliasing rules
if used incorrectly, making it unsafe to call. Read moreSource§fn apply_deferred(&mut self, _world: &mut World)
fn apply_deferred(&mut self, _world: &mut World)
Source§fn queue_deferred(&mut self, _world: DeferredWorld<'_>)
fn queue_deferred(&mut self, _world: DeferredWorld<'_>)
Enqueues any
Deferred
system parameters (or other system buffers)
of this system into the world’s command buffer.Source§unsafe fn validate_param_unsafe(
&mut self,
_world: UnsafeWorldCell<'_>,
) -> Result<(), SystemParamValidationError>
unsafe fn validate_param_unsafe( &mut self, _world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>
Validates that all parameters can be acquired and that system can run without panic.
Built-in executors use this to prevent invalid systems from running. Read more
Source§fn initialize(&mut self, world: &mut World) -> FilteredAccessSet
fn initialize(&mut self, world: &mut World) -> FilteredAccessSet
Initialize the system. Read more
Source§fn check_change_tick(&mut self, check: CheckChangeTicks)
fn check_change_tick(&mut self, check: CheckChangeTicks)
Source§fn default_system_sets(&self) -> Vec<InternedSystemSet> ⓘ
fn default_system_sets(&self) -> Vec<InternedSystemSet> ⓘ
Returns the system’s default system sets. Read more
Source§fn get_last_run(&self) -> Tick
fn get_last_run(&self) -> Tick
Gets the tick indicating the last time this system ran.
Source§fn set_last_run(&mut self, last_run: Tick)
fn set_last_run(&mut self, last_run: Tick)
Overwrites the tick indicating the last time this system ran. Read more
Source§fn is_exclusive(&self) -> bool
fn is_exclusive(&self) -> bool
Returns true if the system must be run exclusively.
Source§fn has_deferred(&self) -> bool
fn has_deferred(&self) -> bool
Returns true if system has deferred buffers.
Source§fn run(
&mut self,
input: SystemIn<'_, Self>,
world: &mut World,
) -> Result<Self::Out, RunSystemError>
fn run( &mut self, input: SystemIn<'_, Self>, world: &mut World, ) -> Result<Self::Out, RunSystemError>
Runs the system with the given input in the world. Read more
Source§fn run_without_applying_deferred(
&mut self,
input: SystemIn<'_, Self>,
world: &mut World,
) -> Result<Self::Out, RunSystemError>
fn run_without_applying_deferred( &mut self, input: SystemIn<'_, Self>, world: &mut World, ) -> Result<Self::Out, RunSystemError>
Runs the system with the given input in the world.
Source§fn validate_param(
&mut self,
world: &World,
) -> Result<(), SystemParamValidationError>
fn validate_param( &mut self, world: &World, ) -> Result<(), SystemParamValidationError>
Safe version of
System::validate_param_unsafe
.
that runs on exclusive, single-threaded world
pointer.Auto Trait Implementations§
impl<Marker, Out, F> Freeze for ExclusiveFunctionSystem<Marker, Out, F>where
F: Freeze,
<<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: Freeze,
impl<Marker, Out, F> !RefUnwindSafe for ExclusiveFunctionSystem<Marker, Out, F>
impl<Marker, Out, F> Send for ExclusiveFunctionSystem<Marker, Out, F>
impl<Marker, Out, F> Sync for ExclusiveFunctionSystem<Marker, Out, F>
impl<Marker, Out, F> Unpin for ExclusiveFunctionSystem<Marker, Out, F>where
F: Unpin,
<<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: Unpin,
impl<Marker, Out, F> !UnwindSafe for ExclusiveFunctionSystem<Marker, Out, F>
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
Mutably borrows from an owned value. Read more
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>
Converts
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>
Converts
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)
Converts
&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)
Converts
&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<E, B, M, Out, S> IntoObserverSystem<E, B, M, Out> for Swhere
E: Event + 'static,
S: IntoSystem<On<'static, 'static, E, B>, Out, M> + Send + 'static,
<S as IntoSystem<On<'static, 'static, E, B>, Out, M>>::System: ObserverSystem<E, B, Out>,
B: Bundle,
impl<E, B, M, Out, S> IntoObserverSystem<E, B, M, Out> for Swhere
E: Event + 'static,
S: IntoSystem<On<'static, 'static, E, B>, Out, M> + Send + 'static,
<S as IntoSystem<On<'static, 'static, E, B>, Out, M>>::System: ObserverSystem<E, B, Out>,
B: Bundle,
Source§type System = <S as IntoSystem<On<'static, 'static, E, B>, Out, M>>::System
type System = <S as IntoSystem<On<'static, 'static, E, B>, Out, M>>::System
The type of
System
that this instance converts into.Source§fn into_system(this: S) -> <S as IntoObserverSystem<E, B, M, Out>>::System
fn into_system(this: S) -> <S as IntoObserverSystem<E, B, M, Out>>::System
Turns this value into its corresponding
System
.Source§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.
Source§impl<F, Marker> IntoScheduleConfigs<Box<dyn System<Out = (), In = ()>>, Marker> for F
impl<F, Marker> IntoScheduleConfigs<Box<dyn System<Out = (), In = ()>>, Marker> for F
Source§fn into_configs(self) -> ScheduleConfigs<Box<dyn System<Out = (), In = ()>>>
fn into_configs(self) -> ScheduleConfigs<Box<dyn System<Out = (), In = ()>>>
Convert into a
ScheduleConfigs
.Source§fn in_set(self, set: impl SystemSet) -> ScheduleConfigs<T>
fn in_set(self, set: impl SystemSet) -> ScheduleConfigs<T>
Add these systems to the provided
set
.Source§fn before<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>
fn before<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>
Source§fn after<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>
fn after<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>
Source§fn before_ignore_deferred<M>(
self,
set: impl IntoSystemSet<M>,
) -> ScheduleConfigs<T>
fn before_ignore_deferred<M>( self, set: impl IntoSystemSet<M>, ) -> ScheduleConfigs<T>
Run before all systems in
set
. Read moreSource§fn after_ignore_deferred<M>(
self,
set: impl IntoSystemSet<M>,
) -> ScheduleConfigs<T>
fn after_ignore_deferred<M>( self, set: impl IntoSystemSet<M>, ) -> ScheduleConfigs<T>
Run after all systems in
set
. Read moreSource§fn distributive_run_if<M>(
self,
condition: impl SystemCondition<M> + Clone,
) -> ScheduleConfigs<T>
fn distributive_run_if<M>( self, condition: impl SystemCondition<M> + Clone, ) -> ScheduleConfigs<T>
Add a run condition to each contained system. Read more
Source§fn run_if<M>(self, condition: impl SystemCondition<M>) -> ScheduleConfigs<T>
fn run_if<M>(self, condition: impl SystemCondition<M>) -> ScheduleConfigs<T>
Source§fn ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>
fn ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> ScheduleConfigs<T>
Suppress warnings and errors that would result from these systems having ambiguities
(conflicting access but indeterminate order) with systems in
set
.Source§fn ambiguous_with_all(self) -> ScheduleConfigs<T>
fn ambiguous_with_all(self) -> ScheduleConfigs<T>
Suppress warnings and errors that would result from these systems having ambiguities
(conflicting access but indeterminate order) with any other system.
Source§fn chain(self) -> ScheduleConfigs<T>
fn chain(self) -> ScheduleConfigs<T>
Treat this collection as a sequence of systems. Read more
Source§fn chain_ignore_deferred(self) -> ScheduleConfigs<T>
fn chain_ignore_deferred(self) -> ScheduleConfigs<T>
Treat this collection as a sequence of systems. Read more
Source§impl<T> IntoSystem<<T as System>::In, <T as System>::Out, ()> for Twhere
T: System,
impl<T> IntoSystem<<T as System>::In, <T as System>::Out, ()> for Twhere
T: System,
Source§fn into_system(this: T) -> T
fn into_system(this: T) -> T
Turns this value into its corresponding
System
.Source§fn pipe<B, BIn, BOut, MarkerB>(self, system: B) -> IntoPipeSystem<Self, B>where
Out: 'static,
B: IntoSystem<BIn, BOut, MarkerB>,
for<'a> BIn: SystemInput<Inner<'a> = Out>,
fn pipe<B, BIn, BOut, MarkerB>(self, system: B) -> IntoPipeSystem<Self, B>where
Out: 'static,
B: IntoSystem<BIn, BOut, MarkerB>,
for<'a> BIn: SystemInput<Inner<'a> = Out>,
Source§fn map<T, F>(self, f: F) -> IntoAdapterSystem<F, Self>
fn map<T, F>(self, f: F) -> IntoAdapterSystem<F, Self>
Pass the output of this system into the passed function
f
, creating a new system that
outputs the value returned from the function. Read moreSource§fn with_input<T>(self, value: T) -> WithInputWrapper<Self::System, T>
fn with_input<T>(self, value: T) -> WithInputWrapper<Self::System, T>
Passes a mutable reference to
value
as input to the system each run,
turning it into a system that takes no input. Read more