Struct sparsey::system::System

source ·
pub struct System<TRegistry = World, TReturn = ()> { /* private fields */ }
Expand description

Encapsulates a function that borrows data from a registry during execution.

Implementations§

source§

impl<TRegistry, TReturn> System<TRegistry, TReturn>

source

pub fn new<TParams>(f: impl IntoSystem<TRegistry, TParams, TReturn>) -> Self

Creates a new system from the given runnable function.

source

pub fn run(&mut self, registry: &TRegistry) -> TReturn

Runs the system in the given registry.

source

pub fn params(&self) -> &[SystemParamKind]

Returns the data that the system borrows from the registry during execution.

Auto Trait Implementations§

§

impl<TRegistry, TReturn> Freeze for System<TRegistry, TReturn>

§

impl<TRegistry = World, TReturn = ()> !RefUnwindSafe for System<TRegistry, TReturn>

§

impl<TRegistry, TReturn> Send for System<TRegistry, TReturn>

§

impl<TRegistry, TReturn> Sync for System<TRegistry, TReturn>

§

impl<TRegistry, TReturn> Unpin for System<TRegistry, TReturn>

§

impl<TRegistry = World, TReturn = ()> !UnwindSafe for System<TRegistry, TReturn>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Resource for T
where T: Send + Sync + 'static,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Upcasts self.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Upcasts self.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Upcasts self.
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.
source§

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