Struct bones_framework :: prelude :: UntypedComponentStore Copy item path

impl 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.

pub fn for_type<T>() -> UntypedComponentStore
where T: HasSchema,

Create an UntypedComponentStore that is valid for the given type T.

pub fn schema(&self) -> &'static Schema

Get the schema of the components stored.

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.

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.

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.

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.

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 the data pointer is not used after pushing.

pub fn get<T>(&self, entity: Entity) -> Option<&T>
where T: HasSchema,

Get a reference to the component storage for the given Entity.

§Panics

Panics if the schema of T doesn’t match.

pub fn try_get<T>( &self, entity: Entity, ) -> Result<Option<&T>, SchemaMismatchError>
where T: HasSchema,

Get a reference to the component storage for the given Entity.

§Errors

Errors if the schema of T doesn’t match.

pub fn get_ref(&self, entity: Entity) -> Option<SchemaRef<'_>>

Get a SchemaRef to the component for the given Entity if the entity has this component.

pub fn get_mut<T>(&mut self, entity: Entity) -> Option<&mut T>
where T: HasSchema,

Get a mutable reference to the component storage for the given Entity.

§Panics

Panics if the schema of T doesn’t match.

pub fn try_get_mut<T>( &mut self, entity: Entity, ) -> Result<Option<&mut T>, SchemaMismatchError>
where T: HasSchema,

Get a mutable reference to the component storage for the given Entity.

§Errors

Errors if the schema of T doesn’t match.

pub fn get_mut_or_insert<T>( &mut self, entity: Entity, f: impl FnOnce() -> T, ) -> &mut T
where T: HasSchema,

Get a mutable reference to component storage for the given Entity if it exists. Otherwise inserts T generated by calling parameter: f.

pub fn get_ref_mut<'a>(&mut self, entity: Entity) -> Option<SchemaRefMut<'a>>

Get a SchemaRefMut to the component for the given Entity

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.

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.

pub fn get_many_ref_mut<const N: usize>( &mut self, entities: [Entity; N], ) -> [Option<SchemaRefMut<'_>>; N]

Get SchemaRefMuts 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.

pub fn remove<T>(&mut self, entity: Entity) -> Option<T>
where T: HasSchema,

Remove the component data for the entity if it exists.

§Errors

Errors if the schema doesn’t match.

pub fn try_remove<T>( &mut self, entity: Entity, ) -> Result<Option<T>, SchemaMismatchError>
where T: HasSchema,

Remove the component data for the entity if it exists.

§Errors

Errors if the schema doesn’t match.

pub fn remove_box(&mut self, entity: Entity) -> Option<SchemaBox>

Remove the component data for the entity if it exists.

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.

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.

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.

pub fn iter(&self) -> UntypedComponentStoreIter<'_> ⓘ

Iterates immutably over all components of this type.

Very fast but doesn’t allow joining with other component types.

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.

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.

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.

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.

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.

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.

pub fn into_typed<T>(self) -> ComponentStore<T>
where T: HasSchema,

Convert into a typed ComponentStore.

§Panics

Panics if the schema doesn’t match.

Trait Implementations§

impl Clone for UntypedComponentStore

fn clone(&self) -> UntypedComponentStore

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Drop for UntypedComponentStore

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<T> TryFrom<UntypedComponentStore> for ComponentStore<T>
where T: HasSchema,

type Error = SchemaMismatchError

The type returned in the event of a conversion error.

fn try_from( untyped: UntypedComponentStore, ) -> Result<ComponentStore<T>, <ComponentStore<T> as TryFrom<UntypedComponentStore>>::Error>

Performs the conversion.

impl Send for UntypedComponentStore

impl Sync for UntypedComponentStore

Auto Trait Implementations§

impl !UnwindSafe for UntypedComponentStore

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

fn into_arc_any(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Casts Arc<Self> into Arc<dyn Any + Send + Sync>.

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

fn into_sample(self) -> T

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> RawClone for T
where T: Clone,

unsafe fn raw_clone(src: const c_void, dst: mut c_void)

Write the default value of the type to the pointer. Read more

fn raw_clone_cb() -> Unsafe<&'static (dyn Fn(const c_void, mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> RawDrop for T

unsafe fn raw_drop(ptr: *mut c_void)

Write the default value of the type to the pointer. Read more

fn raw_drop_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

fn to_sample_(self) -> U

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,