Struct PackedStorage

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

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§

Source§

impl<'a, T> ComponentStorage<'a, T> for PackedStorage<T>
where T: Component,

Source§

type Iter = ComponentIter<'a, T>

An iterator of shared archetype slice references.
Source§

type IterMut = ComponentIterMut<'a, T>

An iterator of mutable archetype slice references.
Source§

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

Copies new components into the specified archetype slice. Read more
Source§

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

Gets the component slice for the specified archetype.
Source§

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

Gets a mutable component slice for the specified archetype. Read more
Source§

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

Iterates through all archetype component slices.
Source§

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. Read more
Source§

fn len(&self) -> usize

Returns the number of archetype slices stored.
Source§

fn is_empty(&self) -> bool

Returns true if the storage contains no archetypes.
Source§

impl<T> Debug for PackedStorage<T>
where T: Debug + Component,

Source§

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

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

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

Source§

fn default() -> PackedStorage<T>

Returns the “default value” for a type. Read more
Source§

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

Source§

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.

Source§

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

Moves a component from one archetype to another.
Source§

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

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

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.
Source§

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.
Source§

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

Packs archetype slices.
Source§

fn fragmentation(&self) -> f32

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

fn element_vtable(&self) -> ComponentMeta

Returns the component metadata.
Source§

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

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

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

Returns a pointer to the given archetype’s component slice. Read more
Source§

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. Read more
Source§

fn increment_epoch(&mut self)

Notifies the storage of the start of a new epoch.
Source§

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.
Source§

impl<T> Send for PackedStorage<T>
where T: Component,

Source§

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

Auto Trait Implementations§

§

impl<T> Freeze for PackedStorage<T>

§

impl<T> !RefUnwindSafe for PackedStorage<T>

§

impl<T> Unpin for PackedStorage<T>

§

impl<T> UnwindSafe for PackedStorage<T>
where T: RefUnwindSafe,

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> Component for T
where T: 'static + Send + Sync,

Source§

type Storage = PackedStorage<T>

The storage type required to hold all instances of this component in a world.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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, 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.
Source§

impl<T> Resource for T
where T: 'static,