Struct valence::prelude::NonSend

pub struct NonSend<'w, T>
where
    T: 'static,
{ /* private fields */ }

Shared borrow of a non-Send resource.

Only Send resources may be accessed with the Res SystemParam. In case that the resource does not implement Send, this SystemParam wrapper can be used. This will instruct the scheduler to instead run the system on the main thread so that it doesn’t send the resource over to another thread.

Panics

Panics when used as a SystemParameter if the resource does not exist.

Use Option<NonSend<T>> instead if the resource might not always exist.

Implementations

impl<'w, T> NonSend<'w, T>

where T: 'static,

pub fn is_added(&self) -> bool

Returns true if the resource was added after the system last ran.

pub fn is_changed(&self) -> bool

Returns true if the resource was added or mutably dereferenced after the system last ran.

Trait Implementations

impl<'w, T> Debug for NonSend<'w, T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'w, T> Deref for NonSend<'w, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<NonSend<'w, T> as Deref>::Target

Dereferences the value.

impl<'a, T> From<NonSendMut<'a, T>> for NonSend<'a, T>

fn from(nsm: NonSendMut<'a, T>) -> NonSend<'a, T>

Converts to this type from the input type.

impl<'a, T> SystemParam for NonSend<'a, T>

where T: 'static,

type State = ComponentId

Used to store data which persists across invocations of a system.

type Item<'w, 's> = NonSend<'w, T>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state( world: &mut World, system_meta: &mut SystemMeta, ) -> <NonSend<'a, T> as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn get_param<'w, 's>( _: &'s mut <NonSend<'a, T> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> <NonSend<'a, T> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next apply_deferred.

impl<'w, T> ReadOnlySystemParam for NonSend<'w, T>