moirai-for-games 0.1.0

A small deterministic no_std ECS for constrained and headless games
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
46
47
48
49
50
51
52
53
54
55
56
57

/// Where registered component data is stored in the world.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub enum StorageKind {
    /// Per-entity sparse set; default for tags and ordinary data components today.
    Sparse,
    /// Archetype column storage for table-backed components (Phase 3).
    Table,
}

/// Registration-time storage layout and tag policy for one component type.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct ComponentOptions {
    storage: StorageKind,
    is_tag: bool,
}

impl ComponentOptions {
    /// Default sparse-set storage for ordinary data components.
    pub const fn sparse() -> Self {
        Self {
            storage: StorageKind::Sparse,
            is_tag: false,
        }
    }

    /// Archetype column storage for data components (Phase 3 table backend).
    pub const fn table() -> Self {
        Self {
            storage: StorageKind::Table,
            is_tag: false,
        }
    }

    /// Zero-sized marker component stored in sparse sets.
    pub const fn tag() -> Self {
        Self {
            storage: StorageKind::Sparse,
            is_tag: true,
        }
    }

    #[cfg(test)]
    pub(crate) const fn test_tag_table() -> Self {
        Self {
            storage: StorageKind::Table,
            is_tag: true,
        }
    }

    pub(crate) fn storage(self) -> StorageKind {
        self.storage
    }

    pub(crate) fn is_tag(self) -> bool {
        self.is_tag
    }
}