Struct kaige::storage::PackedStorage

pub struct PackedStorage<T>
where
    T: Component,
{ /* private fields */ }

Stores a slice of components of type T for each archetype. Archetype slices are sorted according to the group that component T belongs to. Each slice may be packed into a single allocation to optimise for group-based access.

Trait Implementations

impl<'a, T> ComponentStorage<'a, T> for PackedStorage<T>

where T: Component,

type Iter = ComponentIter<'a, T>

An iterator of shared archetype slice references.

type IterMut = ComponentIterMut<'a, T>

An iterator of mutable archetype slice references.

unsafe fn extend_memcopy( &mut self, archetype: ArchetypeIndex, ptr: *const T, count: usize )

Copies new components into the specified archetype slice.

fn get(&'a self, _: ArchetypeIndex) -> Option<ComponentSlice<'a, T>>

Gets the component slice for the specified archetype.

unsafe fn get_mut( &'a self, _: ArchetypeIndex ) -> Option<ComponentSliceMut<'a, T>>

Gets a mutable component slice for the specified archetype.

fn iter( &'a self, start_inclusive: usize, end_exclusive: usize ) -> <PackedStorage<T> as ComponentStorage<'a, T>>::Iter

Iterates through all archetype component slices.

unsafe fn iter_mut( &'a self, start_inclusive: usize, end_exclusive: usize ) -> <PackedStorage<T> as ComponentStorage<'a, T>>::IterMut

Iterates through all mutable archetype component slices.

fn len(&self) -> usize

Returns the number of archetype slices stored.

fn is_empty(&self) -> bool

Returns true if the storage contains no archetypes.

impl<T> Debug for PackedStorage<T>

where T: Debug + Component,

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

Formats the value using the given formatter.

impl<T> Default for PackedStorage<T>

where T: Component,

fn default() -> PackedStorage<T>

Returns the “default value” for a type.

impl<T> UnknownComponentStorage for PackedStorage<T>

where T: Component,

fn transfer_component( &mut self, src_archetype: ArchetypeIndex, src_component: ComponentIndex, dst_archetype: ArchetypeIndex, dst: &mut (dyn UnknownComponentStorage + 'static) )

Moves a component to a new storage.

fn move_component( &mut self, source: ArchetypeIndex, index: ComponentIndex, dst: ArchetypeIndex )

Moves a component from one archetype to another.

fn insert_archetype(&mut self, archetype: ArchetypeIndex, index: Option<usize>)

Inserts a new empty component slice for an archetype into this storage.

fn transfer_archetype( &mut self, src_archetype: ArchetypeIndex, dst_archetype: ArchetypeIndex, dst: &mut (dyn UnknownComponentStorage + 'static) )

Moves an archetype’s component slice to a new storage.

fn swap_remove(&mut self, archetype: ArchetypeIndex, index: ComponentIndex)

Removes a component from an archetype slice, swapping it with the last component in the slice.

fn pack(&mut self, age_threshold: u64) -> usize

Packs archetype slices.

fn fragmentation(&self) -> f32

A heuristic estimating cache misses for an iteration through all components due to archetype fragmentation.

fn element_vtable(&self) -> ComponentMeta

Returns the component metadata.

fn get_raw(&self, _: ArchetypeIndex) -> Option<(*const u8, usize)>

Returns a pointer to the given archetype’s component slice.

unsafe fn get_mut_raw(&self, _: ArchetypeIndex) -> Option<(*mut u8, usize)>

Returns a pointer to the given archetype’s component slice.

unsafe fn extend_memcopy_raw( &mut self, _: ArchetypeIndex, ptr: *const u8, count: usize )

Writes new components into the given archetype’s component slice via a memcopy.

fn increment_epoch(&mut self)

Notifies the storage of the start of a new epoch.

fn ensure_capacity(&mut self, _: ArchetypeIndex, capacity: usize)

Ensures that the given spare capacity is available for component insertions. This is a performance hint and should not be required before extend_memcopy is called.

impl<T> Send for PackedStorage<T>

where T: Component,

impl<T> Sync for PackedStorage<T>

where T: Component,