brood 0.9.1

A fast and flexible entity component system library.
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

use crate::{
    archetype,
    registry::Registry,
};
use core::{
    fmt,
    fmt::Debug,
};
use fnv::FnvBuildHasher;
use hashbrown::HashMap;

/// Defines an entity's location.
///
/// This is used by the entity allocator to map from an entity identifier to the actual entity.
pub(crate) struct Location<R>
where
    R: Registry,
{
    /// The identifier of the archetype currently storing this entity.
    pub(crate) identifier: archetype::IdentifierRef<R>,
    /// The index of the entity within its archetype.
    pub(crate) index: usize,
}

impl<R> Location<R>
where
    R: Registry,
{
    /// Creates a new location from an archetype identifier and an index within that archetype.
    pub(crate) fn new(identifier: archetype::IdentifierRef<R>, index: usize) -> Self {
        Self { identifier, index }
    }

    /// Clone using a new set of archetype identifiers.
    ///
    /// This is for cloning of an entire world, in which case the archetype identifiers will
    /// change.
    ///
    /// # Safety
    /// `identifier_map` must contain an entry for `self.identifier`.
    pub(super) unsafe fn clone_with_new_identifier(
        &self,
        identifier_map: &HashMap<
            archetype::IdentifierRef<R>,
            archetype::IdentifierRef<R>,
            FnvBuildHasher,
        >,
    ) -> Self {
        Self {
            // SAFETY: `identifier_map` is guaranteed to contain an entry for `self.identifier`.
            identifier: *unsafe { identifier_map.get(&self.identifier).unwrap_unchecked() },
            index: self.index,
        }
    }
}

impl<R> Clone for Location<R>
where
    R: Registry,
{
    fn clone(&self) -> Self {
        *self
    }
}

impl<R> Copy for Location<R> where R: Registry {}

impl<R> Debug for Location<R>
where
    R: Registry,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Location")
            .field("identifier", &self.identifier)
            .field("index", &self.index)
            .finish()
    }
}

impl<R> PartialEq for Location<R>
where
    R: Registry,
{
    fn eq(&self, other: &Self) -> bool {
        // SAFETY: The slices created here do not outlive their respective identifiers.
        unsafe {
            self.identifier.as_slice() == other.identifier.as_slice() && self.index == other.index
        }
    }
}

#[cfg(test)]
mod tests {
    use super::Location;
    use crate::{
        archetype::Identifier,
        Registry,
    };
    use alloc::vec;

    macro_rules! create_components {
        ($( $variants:ident ),*) => {
            $(
                struct $variants(f32);
            )*
        };
    }

    create_components!(
        A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z
    );

    type Registry =
        Registry!(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z);

    #[test]
    fn new() {
        let identifier = unsafe { Identifier::<Registry>::new(vec![1, 2, 3, 0]) };
        let location = Location::new(unsafe { identifier.as_ref() }, 42);

        assert_eq!(location.identifier, unsafe { identifier.as_ref() });
        assert_eq!(location.index, 42);
    }
}