Struct chunked::chunk::Chunk

pub struct Chunk { /* fields omitted */ }

A single Chunk of entities of the same Archetype.

The components are stored as a struct of arrays in one contiguous block of memory.

Implementations

impl Chunk

pub unsafe fn from_raw(
    archetype: Arc<Archetype>,
    ptr: NonNull<u8>,
    len: usize
) -> Chunk

Create a new chunk from the raw parts.

pub fn archetype(&self) -> &Arc<Archetype>

Return the Archetype this chunk belongs to.

pub fn len(&self) -> usize

Get the total number of entities currently stored in this chunk.

pub fn capacity(&self) -> usize

Get the total capacity of this chunk (usually this is fixed).

pub fn layout(&self) -> Layout

Get the memory layout of this chunk.

pub fn components<T: Component>(&self) -> Option<&[T]>

Get a slice of components from this chunk.

pub fn components_mut<T: Component>(&mut self) -> Option<&mut [T]>

Get a mutable list of components from this chunk.

pub fn split_by_component_mut(&mut self) -> ChunkSplitter<'_>

Create a new ChunkSplitter for accessing multiple component lists at the same time.

pub fn update_at<'a>(
    &mut self,
    index: usize,
    component_data: &impl ComponentData<'a>
)

Update the components of an entity in this chunk at the given index.

pub fn replace_at<'a>(
    &mut self,
    index: usize,
    component_data: &impl ComponentData<'a>
)

Replace the entity at the given index.

pub fn insert<'a>(
    &mut self,
    index: usize,
    component_data: &impl ComponentData<'a>
)

Insert an entity into this chunk, using the factory function provided to fill components.

pub fn copy_from(
    &mut self,
    insert_at: usize,
    other: &Chunk,
    range: impl RangeBounds<usize>
)

Insert a number of entities from another chunk at the given index.

pub fn remove(&mut self, range: impl RangeBounds<usize>)

Remove an entity from this chunk by its index into the chunk.

pub fn entity_by_index(self: &Arc<Chunk>, index: usize) -> Option<EntityEntry>

Get an entity entry by index.

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl Drop for Chunk

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Chunk

impl Sync for Chunk