flax 0.7.1

An ergonomic archetypical ECS
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

use crate::{
    buffer::ComponentBuffer,
    component::{ComponentDesc, ComponentValue},
    components::name,
};

mod debuggable;
mod relation;

pub use debuggable::*;
pub use relation::*;

/// Additional data that can attach itself to a component
///
/// Implementors of this trait are proxy types for attaching the proper
/// components.
pub trait Metadata<T: ComponentValue> {
    /// Attach the metadata to the component buffer
    fn attach(desc: ComponentDesc, buffer: &mut ComponentBuffer);
}

#[derive(Debug, Clone)]
/// Provides a name for components
pub struct Name;

impl<T> Metadata<T> for Name
where
    T: ComponentValue,
{
    fn attach(desc: ComponentDesc, buffer: &mut ComponentBuffer) {
        buffer.set(name(), desc.name().into());
    }
}

#[cfg(test)]
mod test {
    use alloc::string::String;

    use crate::component;

    use super::*;

    #[test]
    fn metadata_attach() {
        component! {
            foo: String => [crate::Debuggable],
        }

        let meta = foo().desc().create_meta();

        assert!(meta.get(debuggable()).is_some());
        assert_eq!(meta.get(name()), Some(&"foo".into()));
    }
}