Struct bevy_internal::ecs::storage::ComponentSparseSet

pub struct ComponentSparseSet { /* private fields */ }

A sparse data structure of Components

Designed for relatively fast insertions and deletions.

Implementations

impl ComponentSparseSet

pub fn new(
    component_info: &ComponentInfo,
    capacity: usize
) -> ComponentSparseSet

pub fn clear(&mut self)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub unsafe fn insert(
    &mut self,
    entity: Entity,
    value: *mut u8,
    change_tick: u32
)

Inserts the entity key and component value pair into this sparse set. This collection takes ownership of the contents of value, and will drop the value when needed. Also, it may overwrite the contents of the value pointer if convenient. The caller is responsible for ensuring it does not drop *value after calling insert.

Safety

• The value pointer must point to a valid address that matches the Layout inside the ComponentInfo given when constructing this sparse set.
• The caller is responsible for ensuring it does not drop *value after calling insert.

pub fn contains(&self, entity: Entity) -> bool

pub fn get(&self, entity: Entity) -> Option<*mut u8>

Safety

ensure the same entity is not accessed twice at the same time

pub unsafe fn get_with_ticks(
    &self,
    entity: Entity
) -> Option<(*mut u8, *mut ComponentTicks)>

Safety

ensure the same entity is not accessed twice at the same time

pub fn get_ticks(&self, entity: Entity) -> Option<&ComponentTicks>

pub fn remove_and_forget(&mut self, entity: Entity) -> Option<*mut u8>

Removes the entity from this sparse set and returns a pointer to the associated value (if it exists). It is the caller’s responsibility to drop the returned ptr (if Some is returned).

pub fn remove(&mut self, entity: Entity) -> bool

Trait Implementations

impl Debug for ComponentSparseSet

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

Formats the value using the given formatter.