pub struct ExclusiveFunctionSystem<Marker, 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 ExclusiveSystemParams.

ExclusiveFunctionSystem must be .initialized before they can be run.

Trait Implementations§

§

impl<Marker, F> System for ExclusiveFunctionSystem<Marker, F>where Marker: 'static, F: ExclusiveSystemParamFunction<Marker>,

§

type In = <F as ExclusiveSystemParamFunction<Marker>>::In

The system’s input. See In for FunctionSystems.
§

type Out = <F as ExclusiveSystemParamFunction<Marker>>::Out

The system’s output.
§

fn name(&self) -> Cow<'static, str>

Returns the system’s name.
§

fn type_id(&self) -> TypeId

Returns the TypeId of the underlying system type.
§

fn component_access(&self) -> &Access<ComponentId>

Returns the system’s component Access.
§

fn archetype_component_access(&self) -> &Access<ArchetypeComponentId>

Returns the system’s archetype component Access.
§

fn is_send(&self) -> bool

Returns true if the system is Send.
§

unsafe fn run_unsafe( &mut self, _input: <ExclusiveFunctionSystem<Marker, F> as System>::In, _world: &World ) -> <ExclusiveFunctionSystem<Marker, F> as System>::Out

Runs the system with the given input in the world. Unlike System::run, this function takes a shared reference to World and may therefore break Rust’s aliasing rules, making it unsafe to call. Read more
§

fn run( &mut self, input: <ExclusiveFunctionSystem<Marker, F> as System>::In, world: &mut World ) -> <ExclusiveFunctionSystem<Marker, F> as System>::Out

Runs the system with the given input in the world.
§

fn is_exclusive(&self) -> bool

Returns true if the system must be run exclusively.
§

fn get_last_change_tick(&self) -> u32

Gets the system’s last change tick
§

fn set_last_change_tick(&mut self, last_change_tick: u32)

Sets the system’s last change tick Read more
§

fn apply_buffers(&mut self, _world: &mut World)

§

fn initialize(&mut self, world: &mut World)

Initialize the system.
§

fn update_archetype_component_access(&mut self, _world: &World)

Update the system’s archetype component Access.
§

fn check_change_tick(&mut self, change_tick: u32)

§

fn default_system_sets( &self ) -> Vec<Box<dyn SystemSet + 'static, Global>, Global>

Returns the system’s default system sets.

Auto Trait Implementations§

§

impl<Marker, F> RefUnwindSafe for ExclusiveFunctionSystem<Marker, F>where F: RefUnwindSafe, <<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: RefUnwindSafe,

§

impl<Marker, F> Send for ExclusiveFunctionSystem<Marker, F>

§

impl<Marker, F> Sync for ExclusiveFunctionSystem<Marker, F>

§

impl<Marker, F> Unpin for ExclusiveFunctionSystem<Marker, F>where F: Unpin, <<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: Unpin,

§

impl<Marker, F> UnwindSafe for ExclusiveFunctionSystem<Marker, F>where F: UnwindSafe, <<F as ExclusiveSystemParamFunction<Marker>>::Param as ExclusiveSystemParam>::State: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

§

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 Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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 + 'static>

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 Twhere T: Any + Send + Sync,

§

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

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

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

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 Twhere U: From<T>,

const: unstable · 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<SystemA, ParamA, Payload, SystemB, ParamB, Out> IntoPipeSystem<ParamA, Payload, SystemB, ParamB, Out> for SystemAwhere SystemA: IntoSystem<(), Payload, ParamA>, SystemB: IntoSystem<Payload, Out, ParamB>,

§

fn pipe( self, system: SystemB ) -> CombinatorSystem<Pipe, <SystemA as IntoSystem<(), Payload, ParamA>>::System, <SystemB as IntoSystem<Payload, Out, ParamB>>::System>

Pass the output of this system A into a second system B, creating a new compound system.
§

impl<In, Out, Sys> IntoSystem<In, Out, ()> for Syswhere Sys: System<In = In, Out = Out>,

§

type System = Sys

§

fn into_system(this: Sys) -> Sys

Turns this value into its corresponding System.
§

impl<Marker, T> IntoSystemAppConfig<Marker> for Twhere T: IntoSystemConfig<Marker, SystemConfig>,

§

fn into_app_config(self) -> SystemAppConfig

Converts into a SystemAppConfig.
§

fn in_schedule(self, schedule: impl ScheduleLabel) -> SystemAppConfig

Adds the system to the provided schedule. Read more
§

fn on_startup(self) -> SystemAppConfig

Adds the system to CoreSchedule::Startup. This is a shorthand for self.in_schedule(CoreSchedule::Startup). Read more
§

impl<Marker, F> IntoSystemConfig<Marker, SystemConfig> for Fwhere F: IntoSystem<(), (), Marker>,

§

fn into_config(self) -> SystemConfig

§

fn in_set(self, set: impl FreeSystemSet) -> Config

Add to set membership.
§

fn in_base_set(self, set: impl BaseSystemSet) -> Config

Add to the provided “base” set. For more information on base sets, see SystemSet::is_base.
§

fn no_default_base_set(self) -> Config

Don’t add this system to the schedules’s default set.
§

fn before<M>(self, set: impl IntoSystemSet<M>) -> Config

Run before all systems in set.
§

fn after<M>(self, set: impl IntoSystemSet<M>) -> Config

Run after all systems in set.
§

fn run_if<M>(self, condition: impl Condition<M>) -> Config

Run only if the Condition is true. Read more
§

fn ambiguous_with<M>(self, set: impl IntoSystemSet<M>) -> Config

Suppress warnings and errors that would result from this system having ambiguities (conflicting access but indeterminate order) with systems in set.
§

fn ambiguous_with_all(self) -> Config

Suppress warnings and errors that would result from this system having ambiguities (conflicting access but indeterminate order) with any other system.
§

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

§

fn to_sample_(self) -> U

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

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
§

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

§

impl<T> Event for Twhere T: Send + Sync + 'static,