sky_ecs 0.1.3

High-performance typed chunk-based ECS for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

#![deny(unsafe_op_in_unsafe_fn)]

//! Unsafe ECS escape hatches for benchmarks and engine-level tooling.
//!
//! Normal gameplay and tools should prefer the typed ECS API or
//! [`crate::ecs::dynamic`]. Everything in this module exposes storage-level
//! contracts directly to the caller.

use super::{world::World, EntityId};

pub use super::archetype::{create_archetype, Archetype, ArchetypeBuilder};
pub use super::chunk::Chunk;
pub use super::query::PreparedQuery;
pub use sky_type::{
    register as register_component_type, type_of as component_type, Type as ComponentType,
    TypeInfo as ComponentTypeInfo,
};

pub trait WorldExpertExt {
    /// Adds an entity with uninitialized component columns.
    ///
    /// # Safety
    ///
    /// The caller must initialize every component in `archetype` for the
    /// returned entity before the entity is queried, structurally moved,
    /// removed, or dropped.
    unsafe fn spawn_uninit(&mut self, archetype: Archetype) -> EntityId;
}

/// Returns the number of component signatures interned by this process.
///
/// Interned archetypes intentionally remain alive for the process lifetime so
/// [`Archetype`] stays a compact `Copy` handle. This diagnostic helps editors
/// and scripting hosts detect accidentally unbounded schema generation.
pub fn interned_archetype_count() -> usize {
    super::archetype::interned_archetype_count()
}

impl WorldExpertExt for World {
    unsafe fn spawn_uninit(&mut self, archetype: Archetype) -> EntityId {
        // SAFETY: the trait method forwards World::add_entity's obligation to
        // its caller: every component slot must be initialized before use.
        unsafe { World::add_entity(self, archetype) }
    }
}