Struct bones_framework::prelude::UntypedComponentStore
source · pub struct UntypedComponentStore { /* private fields */ }
Expand description
Holds components of a given type indexed by Entity
.
We do not check if the given entity is alive here, this should be done using Entities
.
Implementations§
source§impl UntypedComponentStore
impl UntypedComponentStore
sourcepub fn new(schema: &'static Schema) -> UntypedComponentStore
pub fn new(schema: &'static Schema) -> UntypedComponentStore
Create a arbitrary UntypedComponentStore
.
In Rust, you will usually not use UntypedComponentStore
and will use the statically
typed ComponentStore<T>
instead.
sourcepub fn for_type<T>() -> UntypedComponentStorewhere
T: HasSchema,
pub fn for_type<T>() -> UntypedComponentStorewhere
T: HasSchema,
Create an UntypedComponentStore
that is valid for the given type T
.
sourcepub fn insert_box(
&mut self,
entity: Entity,
data: SchemaBox,
) -> Option<SchemaBox>
pub fn insert_box( &mut self, entity: Entity, data: SchemaBox, ) -> Option<SchemaBox>
Insert component data for the given entity and get the previous component data if present.
§Panics
Panics if the schema of T
doesn’t match the store.
sourcepub fn try_insert_box(
&mut self,
entity: Entity,
data: SchemaBox,
) -> Result<Option<SchemaBox>, SchemaMismatchError>
pub fn try_insert_box( &mut self, entity: Entity, data: SchemaBox, ) -> Result<Option<SchemaBox>, SchemaMismatchError>
Insert component data for the given entity and get the previous component data if present.
§Errors
Errors if the schema of T
doesn’t match the store.
sourcepub fn insert<T>(&mut self, entity: Entity, data: T) -> Option<T>where
T: HasSchema,
pub fn insert<T>(&mut self, entity: Entity, data: T) -> Option<T>where
T: HasSchema,
Insert component data for the given entity and get the previous component data if present.
§Panics
Panics if the schema of T
doesn’t match the store.
sourcepub fn try_insert<T>(
&mut self,
entity: Entity,
data: T,
) -> Result<Option<T>, SchemaMismatchError>where
T: HasSchema,
pub fn try_insert<T>(
&mut self,
entity: Entity,
data: T,
) -> Result<Option<T>, SchemaMismatchError>where
T: HasSchema,
Insert component data for the given entity and get the previous component data if present.
§Errors
Errors if the schema of T
doesn’t match the store.
sourcepub unsafe fn insert_raw(&mut self, entity: Entity, data: *mut c_void) -> bool
pub unsafe fn insert_raw(&mut self, entity: Entity, data: *mut c_void) -> bool
Returns true if the entity already had a component of this type.
If true is returned, the previous value of the pointer will be written to data
.
§Safety
- The data must be a pointer to memory with the same schema.
- If
false
is returned you must ensure thedata
pointer is not used after pushing.
sourcepub fn try_get<T>(
&self,
entity: Entity,
) -> Result<Option<&T>, SchemaMismatchError>where
T: HasSchema,
pub fn try_get<T>(
&self,
entity: Entity,
) -> Result<Option<&T>, SchemaMismatchError>where
T: HasSchema,
sourcepub fn try_get_mut<T>(
&mut self,
entity: Entity,
) -> Result<Option<&mut T>, SchemaMismatchError>where
T: HasSchema,
pub fn try_get_mut<T>(
&mut self,
entity: Entity,
) -> Result<Option<&mut T>, SchemaMismatchError>where
T: HasSchema,
sourcepub fn get_mut_or_insert<T>(
&mut self,
entity: Entity,
f: impl FnOnce() -> T,
) -> &mut Twhere
T: HasSchema,
pub fn get_mut_or_insert<T>(
&mut self,
entity: Entity,
f: impl FnOnce() -> T,
) -> &mut Twhere
T: HasSchema,
Get a mutable reference to component storage for the given Entity
if it exists. Otherwise inserts T
generated by calling parameter: f
.
sourcepub fn get_ref_mut<'a>(&mut self, entity: Entity) -> Option<SchemaRefMut<'a>>
pub fn get_ref_mut<'a>(&mut self, entity: Entity) -> Option<SchemaRefMut<'a>>
Get a SchemaRefMut
to the component for the given Entity
sourcepub fn get_many_mut<const N: usize, T>(
&mut self,
entities: [Entity; N],
) -> [Option<&mut T>; N]where
T: HasSchema,
pub fn get_many_mut<const N: usize, T>(
&mut self,
entities: [Entity; N],
) -> [Option<&mut T>; N]where
T: HasSchema,
Get mutable references s to the component data for multiple entities at the same time.
§Panics
This will panic if the same entity is specified multiple times. This is invalid because it would mean you would have two mutable references to the same component data at the same time.
This will also panic if there is a schema mismatch.
sourcepub fn try_get_many_mut<const N: usize, T>(
&mut self,
entities: [Entity; N],
) -> Result<[Option<&mut T>; N], SchemaMismatchError>where
T: HasSchema,
pub fn try_get_many_mut<const N: usize, T>(
&mut self,
entities: [Entity; N],
) -> Result<[Option<&mut T>; N], SchemaMismatchError>where
T: HasSchema,
Get mutable references s to the component data for multiple entities at the same time.
§Panics
This will panic if the same entity is specified multiple times. This is invalid because it would mean you would have two mutable references to the same component data at the same time.
§Errors
This will error if there is a schema mismatch.
sourcepub fn get_many_ref_mut<const N: usize>(
&mut self,
entities: [Entity; N],
) -> [Option<SchemaRefMut<'_>>; N]
pub fn get_many_ref_mut<const N: usize>( &mut self, entities: [Entity; N], ) -> [Option<SchemaRefMut<'_>>; N]
Get SchemaRefMut
s to the component data for multiple entities at the same time.
§Panics
This will panic if the same entity is specified multiple times. This is invalid because it would mean you would have two mutable references to the same component data at the same time.
sourcepub fn try_remove<T>(
&mut self,
entity: Entity,
) -> Result<Option<T>, SchemaMismatchError>where
T: HasSchema,
pub fn try_remove<T>(
&mut self,
entity: Entity,
) -> Result<Option<T>, SchemaMismatchError>where
T: HasSchema,
sourcepub fn remove_box(&mut self, entity: Entity) -> Option<SchemaBox>
pub fn remove_box(&mut self, entity: Entity) -> Option<SchemaBox>
Remove the component data for the entity if it exists.
sourcepub unsafe fn remove_raw(
&mut self,
entity: Entity,
out: Option<*mut c_void>,
) -> bool
pub unsafe fn remove_raw( &mut self, entity: Entity, out: Option<*mut c_void>, ) -> bool
If there is a previous value, true
will be returned.
If out
is set and true is returned, the previous value will be written to it.
§Safety
If set, the out
pointer, must not overlap the internal component storage.
sourcepub fn get_single_with_bitset(
&self,
bitset: Rc<BitSetVec>,
) -> Result<SchemaRef<'_>, QuerySingleError>
pub fn get_single_with_bitset( &self, bitset: Rc<BitSetVec>, ) -> Result<SchemaRef<'_>, QuerySingleError>
Get a reference to the component store if there is exactly one instance of the component.
sourcepub fn get_single_with_bitset_mut(
&mut self,
bitset: Rc<BitSetVec>,
) -> Result<SchemaRefMut<'_>, QuerySingleError>
pub fn get_single_with_bitset_mut( &mut self, bitset: Rc<BitSetVec>, ) -> Result<SchemaRefMut<'_>, QuerySingleError>
Get a mutable reference to the component store if there is exactly one instance of the component.
sourcepub fn iter(&self) -> UntypedComponentStoreIter<'_> ⓘ
pub fn iter(&self) -> UntypedComponentStoreIter<'_> ⓘ
Iterates immutably over all components of this type.
Very fast but doesn’t allow joining with other component types.
sourcepub fn iter_mut(&mut self) -> UntypedComponentStoreIterMut<'_> ⓘ
pub fn iter_mut(&mut self) -> UntypedComponentStoreIterMut<'_> ⓘ
Iterates mutably over all components of this type.
Very fast but doesn’t allow joining with other component types.
sourcepub fn iter_with_bitset(
&self,
bitset: Rc<BitSetVec>,
) -> UntypedComponentBitsetIterator<'_> ⓘ
pub fn iter_with_bitset( &self, bitset: Rc<BitSetVec>, ) -> UntypedComponentBitsetIterator<'_> ⓘ
Iterates immutably over the components of this type where bitset
indicates the indices of
entities.
Slower than iter()
but allows joining between multiple component types.
sourcepub fn iter_mut_with_bitset(
&mut self,
bitset: Rc<BitSetVec>,
) -> UntypedComponentBitsetIteratorMut<'_> ⓘ
pub fn iter_mut_with_bitset( &mut self, bitset: Rc<BitSetVec>, ) -> UntypedComponentBitsetIteratorMut<'_> ⓘ
Iterates mutable over the components of this type where bitset
indicates the indices of
entities.
Slower than iter()
but allows joining between multiple component types.
sourcepub fn iter_with_bitset_optional(
&self,
bitset: Rc<BitSetVec>,
) -> UntypedComponentOptionalBitsetIterator<'_> ⓘ
pub fn iter_with_bitset_optional( &self, bitset: Rc<BitSetVec>, ) -> UntypedComponentOptionalBitsetIterator<'_> ⓘ
Iterates immutably over the components of this type where bitset
indicates the indices of
entities. Iterator provides Option, returning None if there is no component for entity in bitset.
sourcepub fn iter_mut_with_bitset_optional(
&mut self,
bitset: Rc<BitSetVec>,
) -> UntypedComponentOptionalBitsetIteratorMut<'_> ⓘ
pub fn iter_mut_with_bitset_optional( &mut self, bitset: Rc<BitSetVec>, ) -> UntypedComponentOptionalBitsetIteratorMut<'_> ⓘ
Iterates mutably over the components of this type where bitset
indicates the indices of
entities. Iterator provides Option, returning None if there is no component for entity in bitset.
sourcepub fn bitset(&self) -> &BitSetVec
pub fn bitset(&self) -> &BitSetVec
Returns the bitset indicating which entity indices have a component associated to them.
Useful to build conditions between multiple Components
’ bitsets.
For example, take two bitsets from two different Components
types. Then,
bitset1.clone().bit_and(bitset2); And finally, you can use bitset1 in iter_with_bitset
and
iter_mut_with_bitset
. This will iterate over the components of the entity only for
entities that have both components.
sourcepub fn into_typed<T>(self) -> ComponentStore<T>where
T: HasSchema,
pub fn into_typed<T>(self) -> ComponentStore<T>where
T: HasSchema,
Trait Implementations§
source§impl Clone for UntypedComponentStore
impl Clone for UntypedComponentStore
source§fn clone(&self) -> UntypedComponentStore
fn clone(&self) -> UntypedComponentStore
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Drop for UntypedComponentStore
impl Drop for UntypedComponentStore
source§impl<T> TryFrom<UntypedComponentStore> for ComponentStore<T>where
T: HasSchema,
impl<T> TryFrom<UntypedComponentStore> for ComponentStore<T>where
T: HasSchema,
§type Error = SchemaMismatchError
type Error = SchemaMismatchError
source§fn try_from(
untyped: UntypedComponentStore,
) -> Result<ComponentStore<T>, <ComponentStore<T> as TryFrom<UntypedComponentStore>>::Error>
fn try_from( untyped: UntypedComponentStore, ) -> Result<ComponentStore<T>, <ComponentStore<T> as TryFrom<UntypedComponentStore>>::Error>
impl Send for UntypedComponentStore
impl Sync for UntypedComponentStore
Auto Trait Implementations§
impl Freeze for UntypedComponentStore
impl !RefUnwindSafe for UntypedComponentStore
impl Unpin for UntypedComponentStore
impl !UnwindSafe for UntypedComponentStore
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.