PipeSystem

Struct PipeSystem 

Source
pub struct PipeSystem<A, B> { /* private fields */ }
Expand description

A System created by piping the output of the first system into the input of the second.

This can be repeated indefinitely, but system pipes cannot branch: the output is consumed by the receiving system.

Given two systems A and B, A may be piped into B as A.pipe(B) if the output type of A is equal to the input type of B.

Note that for FunctionSystems the output is the return value of the function and the input is the first SystemParam if it is tagged with In or () if the function has no designated input parameter.

§Examples

use std::num::ParseIntError;

use bevy_ecs::prelude::*;

fn main() {
    let mut world = World::default();
    world.insert_resource(Message("42".to_string()));

    // pipe the `parse_message_system`'s output into the `filter_system`s input
    let mut piped_system = IntoSystem::into_system(parse_message_system.pipe(filter_system));
    piped_system.initialize(&mut world);
    assert_eq!(piped_system.run((), &mut world).unwrap(), Some(42));
}

#[derive(Resource)]
struct Message(String);

fn parse_message_system(message: Res<Message>) -> Result<usize, ParseIntError> {
    message.0.parse::<usize>()
}

fn filter_system(In(result): In<Result<usize, ParseIntError>>) -> Option<usize> {
    result.ok().filter(|&n| n < 100)
}

Implementations§

Source§

impl<A, B> PipeSystem<A, B>
where A: System, B: System, for<'a> B::In: SystemInput<Inner<'a> = A::Out>,

Source

pub fn new(a: A, b: B, name: DebugName) -> Self

Creates a new system that pipes two inner systems.

Trait Implementations§

Source§

impl<A, B> ReadOnlySystem for PipeSystem<A, B>
where A: ReadOnlySystem, B: ReadOnlySystem, for<'a> B::In: SystemInput<Inner<'a> = A::Out>,

SAFETY: Both systems are read-only, so any system created by piping them will only read from the world.

Source§

fn run_readonly( &mut self, input: SystemIn<'_, Self>, world: &World, ) -> Result<Self::Out, RunSystemError>

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

impl<A, B> System for PipeSystem<A, B>
where A: System, B: System, for<'a> B::In: SystemInput<Inner<'a> = A::Out>,

Source§

type In = <A as System>::In

The system’s input.
Source§

type Out = <B as System>::Out

The system’s output.
Source§

fn name(&self) -> DebugName

Returns the system’s name.
Source§

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>

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

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

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>

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

Initialize the system. Read more
Source§

fn check_change_tick(&mut self, check: CheckChangeTicks)

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

fn default_system_sets(&self) -> Vec<InternedSystemSet>

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

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)

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

fn type_id(&self) -> TypeId

Returns the TypeId of the underlying system type.
Source§

fn is_send(&self) -> bool

Returns true if the system is Send.
Source§

fn is_exclusive(&self) -> bool

Returns true if the system must be run exclusively.
Source§

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>

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>

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

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<A, B> Freeze for PipeSystem<A, B>
where A: Freeze, B: Freeze,

§

impl<A, B> RefUnwindSafe for PipeSystem<A, B>

§

impl<A, B> Send for PipeSystem<A, B>
where A: Send, B: Send,

§

impl<A, B> Sync for PipeSystem<A, B>
where A: Sync, B: Sync,

§

impl<A, B> Unpin for PipeSystem<A, B>
where A: Unpin, B: Unpin,

§

impl<A, B> UnwindSafe for PipeSystem<A, B>
where A: UnwindSafe, B: 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> 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 for T
where T: Any,

Source§

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>

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)

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)

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

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<E, B, M, Out, S> IntoObserverSystem<E, B, M, Out> for S
where 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

The type of System that this instance converts into.
Source§

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

Source§

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
where F: IntoSystem<(), (), Marker>,

Source§

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

Convert into a ScheduleConfigs.
Source§

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>

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

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

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

fn before_ignore_deferred<M>( self, set: impl IntoSystemSet<M>, ) -> ScheduleConfigs<T>

Run before all systems in set. Read more
Source§

fn after_ignore_deferred<M>( self, set: impl IntoSystemSet<M>, ) -> ScheduleConfigs<T>

Run after all systems in set. Read more
Source§

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>

Run the systems only if the SystemCondition is true. Read more
Source§

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>

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>

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

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 T
where T: System,

Source§

type System = T

The type of System that this instance converts into.
Source§

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

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

fn map<T, F>(self, f: F) -> IntoAdapterSystem<F, Self>
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
Source§

fn with_input<T>(self, value: T) -> WithInputWrapper<Self::System, T>
where for<'i> In: SystemInput<Inner<'i> = &'i mut T>, T: Send + Sync + 'static,

Passes a mutable reference to value as input to the system each run, turning it into a system that takes no input. Read more
Source§

fn with_input_from<T>(self) -> WithInputFromWrapper<Self::System, T>
where for<'i> In: SystemInput<Inner<'i> = &'i mut T>, T: FromWorld + Send + Sync + 'static,

Passes a mutable reference to a value of type T created via FromWorld as input to the system each run, turning it into a system that takes no input. Read more
Source§

fn system_type_id(&self) -> TypeId

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

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<Marker, In, F> SystemCondition<Marker, In> for F
where In: SystemInput, F: SystemCondition<Marker, In>,

Source§

fn and<M, C: SystemCondition<M, In>>( self, and: C, ) -> And<Self::System, C::System>

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

fn nand<M, C: SystemCondition<M, In>>( self, nand: C, ) -> Nand<Self::System, C::System>

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

fn nor<M, C: SystemCondition<M, In>>( self, nor: C, ) -> Nor<Self::System, C::System>

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

fn or<M, C: SystemCondition<M, In>>(self, or: C) -> Or<Self::System, C::System>

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

fn xnor<M, C: SystemCondition<M, In>>( self, xnor: C, ) -> Xnor<Self::System, C::System>

Returns a new run condition that only returns true if self and xnor both return false or both return true. Read more
Source§

fn xor<M, C: SystemCondition<M, In>>( self, xor: C, ) -> Xor<Self::System, C::System>

Returns a new run condition that only returns true if either self or xor return true, but not both. Read more
Source§

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

Source§

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

Source§

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> 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<T> ConditionalSend for T
where T: Send,

Source§

impl<E, B, Out, T> ObserverSystem<E, B, Out> for T
where E: Event, B: Bundle, T: System<In = On<'static, 'static, E, B>, Out = Out> + Send + 'static,