pub struct NonSend<'w, T: 'static> { /* private fields */ }
Expand description
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.
This SystemParam
fails validation if non-send resource doesn’t exist.
This will cause a panic, but can be configured to do nothing or warn once.
Use Option<NonSend<T>>
instead if the resource might not always exist.
Implementations§
Source§impl<'w, T: 'static> NonSend<'w, T>
impl<'w, T: 'static> NonSend<'w, T>
Sourcepub fn is_added(&self) -> bool
pub fn is_added(&self) -> bool
Returns true
if the resource was added after the system last ran.
Sourcepub fn is_changed(&self) -> bool
pub fn is_changed(&self) -> bool
Returns true
if the resource was added or mutably dereferenced after the system last ran.
Sourcepub fn changed_by(&self) -> MaybeLocation
pub fn changed_by(&self) -> MaybeLocation
The location that last caused this to change.
Trait Implementations§
Source§impl<'a, T> From<NonSendMut<'a, T>> for NonSend<'a, T>
impl<'a, T> From<NonSendMut<'a, T>> for NonSend<'a, T>
Source§fn from(nsm: NonSendMut<'a, T>) -> Self
fn from(nsm: NonSendMut<'a, T>) -> Self
Converts to this type from the input type.
Source§impl<'a, T: 'static> SystemParam for NonSend<'a, T>
impl<'a, T: 'static> SystemParam for NonSend<'a, T>
Source§type State = ComponentId
type State = ComponentId
Used to store data which persists across invocations of a system.
Source§type Item<'w, 's> = NonSend<'w, T>
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. Read moreSource§fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
Registers any
World
access used by this SystemParam
and creates a new instance of this param’s State
.Source§unsafe fn validate_param(
component_id: &Self::State,
_system_meta: &SystemMeta,
world: UnsafeWorldCell<'_>,
) -> Result<(), SystemParamValidationError>
unsafe fn validate_param( component_id: &Self::State, _system_meta: &SystemMeta, world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>
Source§unsafe fn get_param<'w, 's>(
component_id: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick,
) -> Self::Item<'w, 's>
unsafe fn get_param<'w, 's>( component_id: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>
Creates a parameter to be passed into a
SystemParamFunction
. Read moreSource§unsafe fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta,
)
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 Read moreSource§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
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 ApplyDeferred
.Source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>,
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )
Queues any deferred mutations to be applied at the next
ApplyDeferred
.impl<'w, T> ReadOnlySystemParam for NonSend<'w, T>
Auto Trait Implementations§
impl<'w, T> Freeze for NonSend<'w, T>
impl<'w, T> RefUnwindSafe for NonSend<'w, T>where
T: RefUnwindSafe,
impl<'w, T> Send for NonSend<'w, T>where
T: Sync,
impl<'w, T> Sync for NonSend<'w, T>where
T: Sync,
impl<'w, T> Unpin for NonSend<'w, T>
impl<'w, T> UnwindSafe for NonSend<'w, T>where
T: RefUnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.