Struct legion::storage::PackedStorage

pub struct PackedStorage<T: Component> { /* fields omitted */ }

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: Component> ComponentStorage<'a, T> for PackedStorage<T>

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: ArchetypeIndex
) -> Option<ComponentSlice<'a, T>>

Gets the component slice for the specified archetype.

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

Gets a mutable component slice for the specified archetype.

fn iter(&'a self, start_inclusive: usize, end_exclusive: usize) -> Self::Iter

Iterates through all archetype component slices.

unsafe fn iter_mut(
    &'a self,
    start_inclusive: usize,
    end_exclusive: usize
) -> Self::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 + Component> Debug for PackedStorage<T>

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

Formats the value using the given formatter.

impl<T: Component> Default for PackedStorage<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Component> UnknownComponentStorage for PackedStorage<T>

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

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
)

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: Epoch) -> 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: ArchetypeIndex) -> Option<(*const u8, usize)>

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

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

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

unsafe fn extend_memcopy_raw(
    &mut self,
    ArchetypeIndex: 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: 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: Component> Send for PackedStorage<T>

impl<T: Component> Sync for PackedStorage<T>