Struct Chunk

Source
pub struct Chunk { /* private fields */ }
Expand description

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§

Source§

impl Chunk

Source

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

Create a new chunk from the raw parts.

Source

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

Return the Archetype this chunk belongs to.

Source

pub fn len(&self) -> usize

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

Source

pub fn capacity(&self) -> usize

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

Source

pub fn layout(&self) -> Layout

Get the memory layout of this chunk.

Source

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

Get a slice of components from this chunk.

Source

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

Get a mutable list of components from this chunk.

Source

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

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

Source

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.

Source

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

Replace the entity at the given index.

Source

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.

Source

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.

Source

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

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

Source

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

Get an entity entry by index.

Trait Implementations§

Source§

impl Clone for Chunk

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Chunk

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Chunk

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Chunk

Source§

impl Sync for Chunk

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.