Struct bevy::ecs::system::FunctionSystem

pub struct FunctionSystem<Marker, F>
where F: SystemParamFunction<Marker>,
{ /* private fields */ }
Expand description

The System counter part of an ordinary function.

You get this by calling IntoSystem::into_system on a function that only accepts SystemParams. The output of the system becomes the functions return type, while the input becomes the functions In tagged parameter or () if no such parameter exists.

FunctionSystem must be .initialized before they can be run.

The Clone implementation for FunctionSystem returns a new instance which is NOT initialized. The cloned system must also be .initialized before it can be run.

Trait Implementations§

§

impl<Marker, F> Clone for FunctionSystem<Marker, F>
where F: SystemParamFunction<Marker> + Clone,

§

fn clone(&self) -> FunctionSystem<Marker, F>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<Marker, F> ReadOnlySystem for FunctionSystem<Marker, F>
where Marker: 'static, F: SystemParamFunction<Marker>, <F as SystemParamFunction<Marker>>::Param: ReadOnlySystemParam,

SAFETY: F’s param is ReadOnlySystemParam, so this system will only read from the world.

§

fn run_readonly(&mut self, input: Self::In, world: &World) -> Self::Out

Runs this system with the given input in the world. Read more
§

impl<Marker, F> System for FunctionSystem<Marker, F>
where Marker: 'static, F: SystemParamFunction<Marker>,

§

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

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

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

The system’s output.
§

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

Returns the system’s name.
§

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

fn is_exclusive(&self) -> bool

Returns true if the system must be run exclusively.
§

fn has_deferred(&self) -> bool

Returns true if system as deferred buffers
§

unsafe fn run_unsafe( &mut self, input: <FunctionSystem<Marker, F> as System>::In, world: UnsafeWorldCell<'_> ) -> <FunctionSystem<Marker, F> as System>::Out

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

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

Applies any Deferred system parameters (or other system buffers) of this system to the world. Read more
§

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

Initialize the system.
§

fn update_archetype_component_access(&mut self, world: UnsafeWorldCell<'_>)

Update the system’s archetype component Access. Read more
§

fn check_change_tick(&mut self, change_tick: Tick)

Checks any Ticks stored on this system and wraps their value if they get too old. Read more
§

fn default_system_sets(&self) -> Vec<Interned<dyn SystemSet>>

Returns the system’s default system sets. Read more
§

fn get_last_run(&self) -> Tick

Gets the tick indicating the last time this system ran.
§

fn set_last_run(&mut self, last_run: Tick)

Overwrites the tick indicating the last time this system ran. Read more
§

fn type_id(&self) -> TypeId

Returns the TypeId of the underlying system type.
§

fn run(&mut self, input: Self::In, world: &mut World) -> Self::Out

Runs the system with the given input in the world. Read more

Auto Trait Implementations§

§

impl<Marker, F> Freeze for FunctionSystem<Marker, F>
where F: Freeze, <<F as SystemParamFunction<Marker>>::Param as SystemParam>::State: Freeze,

§

impl<Marker, F> !RefUnwindSafe for FunctionSystem<Marker, F>

§

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

§

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

§

impl<Marker, F> Unpin for FunctionSystem<Marker, F>
where F: Unpin, <<F as SystemParamFunction<Marker>>::Param as SystemParam>::State: Unpin,

§

impl<Marker, F> !UnwindSafe for FunctionSystem<Marker, F>

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
§

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

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> 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
§

impl<Marker, In, F> Condition<Marker, In> for F
where F: Condition<Marker, In>,

§

fn and_then<M, C>( self, and_then: C ) -> CombinatorSystem<AndThenMarker, Self::System, <C as IntoSystem<In, bool, M>>::System>
where C: Condition<M, In>,

Returns a new run condition that only returns true if both this one and the passed and_then return true. Read more
§

fn or_else<M, C>( self, or_else: C ) -> CombinatorSystem<OrElseMarker, Self::System, <C as IntoSystem<In, bool, M>>::System>
where C: Condition<M, In>,

Returns a new run condition that returns true if either this one or the passed or_else return true. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

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.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> IntoSystem<<T as System>::In, <T as System>::Out, ()> for T
where T: System,

§

type System = T

The type of System that this instance converts into.
§

fn into_system(this: T) -> T

Turns this value into its corresponding System.
§

fn pipe<B, Final, MarkerB>( self, system: B ) -> CombinatorSystem<Pipe, Self::System, <B as IntoSystem<Out, Final, MarkerB>>::System>
where B: IntoSystem<Out, Final, MarkerB>,

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

fn map<T, F>(self, f: F) -> AdapterSystem<F, Self::System>
where F: Send + Sync + 'static + FnMut(Out) -> T,

Pass the output of this system into the passed function f, creating a new system that outputs the value returned from the function. Read more
§

fn system_type_id(&self) -> TypeId

Get the TypeId of the System produced after calling into_system.
§

impl<Marker, F> IntoSystemConfigs<Marker> for F
where F: IntoSystem<(), (), Marker>,

§

fn into_configs(self) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Convert into a SystemConfigs.
§

fn in_set( self, set: impl SystemSet ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Add these systems to the provided set.
§

fn before<M>( self, set: impl IntoSystemSet<M> ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Runs before all systems in set. If self has any systems that produce Commands or other Deferred operations, all systems in set will see their effect. Read more
§

fn after<M>( self, set: impl IntoSystemSet<M> ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Run after all systems in set. If set has any systems that produce Commands or other Deferred operations, all systems in self will see their effect. Read more
§

fn before_ignore_deferred<M>( self, set: impl IntoSystemSet<M> ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Run before all systems in set. Read more
§

fn after_ignore_deferred<M>( self, set: impl IntoSystemSet<M> ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Run after all systems in set. Read more
§

fn distributive_run_if<M>( self, condition: impl Condition<M> + Clone ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Add a run condition to each contained system. Read more
§

fn run_if<M>( self, condition: impl Condition<M> ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Run the systems only if the Condition is true. Read more
§

fn ambiguous_with<M>( self, set: impl IntoSystemSet<M> ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

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

fn ambiguous_with_all(self) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

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

fn chain(self) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Treat this collection as a sequence of systems. Read more
§

fn chain_ignore_deferred( self ) -> NodeConfigs<Box<dyn System<In = (), Out = ()>>>

Treat this collection as a sequence of systems. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

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

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

§

fn clone_type_data(&self) -> Box<dyn TypeData>

§

impl<T> Upcast<T> for T

§

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

§

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,

§

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

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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