Skip to main content

Single

Struct Single 

Source
pub struct Single<'w, 's, D: IterQueryData + 'static, F: QueryFilter + 'static = ()> { /* private fields */ }
Expand description

Exactly one enabled, runtime-managed entity selected for a System.

Cardinality is a System precondition: if zero or multiple entities match, parameter validation fails before the System body runs and Sim;Logic stops the current stage with a crate::system::SystemRunFailure. Use Query::single when absence or multiplicity is expected control flow that the System should handle itself.

Like Query, this parameter always requires Sim;Logic’s private managed identity and excludes Disabled entities independently of Bevy’s mutable global default-query-filter Resource. crate::identity::LogicEntityRef is the supported way to include the opaque entity handle in D.

Implementations§

Source§

impl<'w, 's, D: IterQueryData + 'static, F: QueryFilter + 'static> Single<'w, 's, D, F>

Source

pub fn into_inner(self) -> D::Item<'w, 's>

Returns the fetched query item without performing another lookup.

This is useful for tuple data containing mutable component borrows.

Trait Implementations§

Source§

impl<'w, 's, D: IterQueryData + 'static, F: QueryFilter + 'static> Deref for Single<'w, 's, D, F>

Source§

type Target = <D as QueryData>::Item<'w, 's>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<'w, 's, D: IterQueryData + 'static, F: QueryFilter + 'static> DerefMut for Single<'w, 's, D, F>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<'w, 's, D: IterQueryData + 'static, F: QueryFilter + 'static> ReadOnlySystemParam for Single<'w, 's, D, F>
where BevySingle<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: ReadOnlySystemParam,

Source§

impl<D: IterQueryData + 'static, F: QueryFilter + 'static> SystemParam for Single<'_, '_, D, F>

Source§

type State = FetchState<D, F>

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

type Item<'w, 's> = Single<'w, 's, D, F>

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

fn init_state(world: &mut World) -> Self::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

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<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<Self::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more

Auto Trait Implementations§

§

impl<'w, 's, D, F> Freeze for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Freeze,

§

impl<'w, 's, D, F> RefUnwindSafe for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: RefUnwindSafe,

§

impl<'w, 's, D, F> Send for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Send,

§

impl<'w, 's, D, F> Sync for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Sync,

§

impl<'w, 's, D, F> Unpin for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: Unpin,

§

impl<'w, 's, D, F> UnsafeUnpin for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: UnsafeUnpin,

§

impl<'w, 's, D, F> UnwindSafe for Single<'w, 's, D, F>
where Single<'w, 's, D, (F, Allow<Disabled>, Without<Disabled>, With<ManagedEntity>)>: 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

impl<T> Downcast for T
where T: Any,

Source§

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

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

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

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

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

Source§

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

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

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