Struct legion::storage::PackedStorage

source · [−]

pub struct PackedStorage<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: 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.

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

Gets the component slice for the specified archetype.

source

unsafe fn get_mut(
&'a self,
ArchetypeIndex: 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) -> Self::Iter

Iterates through all archetype component slices.

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn default() -> Self

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

source

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

source

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.

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
)

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

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

source

unsafe fn get_mut_raw(
&self,
ArchetypeIndex: 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: 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: 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. Read more

source

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

source

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

Auto Trait Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

source

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

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

source

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

source

pub 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. Read more

source

pub 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. Read more

source

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

source

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct legion::storage::PackedStorage

Trait Implementations

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

type Iter = ComponentIter<'a, T>

type IterMut = ComponentIterMut<'a, T>

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

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

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

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

unsafe fn iter_mut( &'a self, start_inclusive: usize, end_exclusive: usize) -> Self::IterMut

fn len(&self) -> usize

fn is_empty(&self) -> bool

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

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

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

fn default() -> Self

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)

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

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

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

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

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

fn fragmentation(&self) -> f32

fn element_vtable(&self) -> ComponentMeta

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

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

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

fn increment_epoch(&mut self)

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

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for PackedStorage<T>

impl<T> Unpin for PackedStorage<T>

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

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

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

unsafe fn iter_mut(
&'a self,
start_inclusive: usize,
end_exclusive: usize
) -> Self::IterMut

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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