mirui 0.42.0

A lightweight, no_std ECS-driven UI framework for embedded, desktop, and WebAssembly
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
125
126

use super::entity::Entity;
use super::world::World;

/// A typed widget builder that defers entity creation: it accumulates
/// configuration at compile time, then unfolds into individual component
/// inserts the moment it is spawned. Implementors own their satellite
/// components (style, handlers) and insert each in [`spawn_into`].
///
/// [`spawn_into`]: IntoBundle::spawn_into
pub trait IntoBundle {
    fn spawn_into(self, world: &mut World, entity: Entity);
}

/// Opt-in marker for types that are a single component. Gates the blanket
/// `IntoBundle` so builders (which impl `IntoBundle` directly) stay coherent.
pub trait Component: 'static {}

impl<C: Component> IntoBundle for C {
    fn spawn_into(self, world: &mut World, entity: Entity) {
        world.insert(entity, self);
    }
}

macro_rules! impl_bundle_for_tuple {
    ($($name:ident),+) => {
        impl<$($name: IntoBundle),+> IntoBundle for ($($name,)+) {
            fn spawn_into(self, world: &mut World, entity: Entity) {
                #[allow(non_snake_case)]
                let ($($name,)+) = self;
                $($name.spawn_into(world, entity);)+
            }
        }
    };
}

impl_bundle_for_tuple!(A);
impl_bundle_for_tuple!(A, B);
impl_bundle_for_tuple!(A, B, C);
impl_bundle_for_tuple!(A, B, C, D);
impl_bundle_for_tuple!(A, B, C, D, E);
impl_bundle_for_tuple!(A, B, C, D, E, F);
impl_bundle_for_tuple!(A, B, C, D, E, F, G);
impl_bundle_for_tuple!(A, B, C, D, E, F, G, H);

impl World {
    /// Allocate an entity and let `bundle` unfold its components onto it.
    pub fn spawn<B: IntoBundle>(&mut self, bundle: B) -> Entity {
        let entity = self.spawn_empty();
        self.insert(entity, crate::ui::Widget);
        bundle.spawn_into(self, entity);
        entity
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    struct Foo(u32);
    struct Bar;
    impl Component for Foo {}
    impl Component for Bar {}
    struct FooBuilder {
        foo: Foo,
        bar: Option<Bar>,
    }
    impl IntoBundle for FooBuilder {
        fn spawn_into(self, world: &mut World, entity: Entity) {
            world.insert(entity, self.foo);
            if let Some(bar) = self.bar {
                world.insert(entity, bar);
            }
        }
    }

    #[test]
    fn spawn_single_component() {
        let mut world = World::default();
        let e = world.spawn(Foo(7));
        assert_eq!(world.get::<Foo>(e).unwrap().0, 7);
    }

    #[test]
    fn spawn_tuple_of_components() {
        let mut world = World::default();
        let e = world.spawn((Foo(3), Bar));
        assert_eq!(world.get::<Foo>(e).unwrap().0, 3);
        assert!(world.has::<Bar>(e));
    }

    #[test]
    fn spawn_tuple_mixing_builder_and_component() {
        let mut world = World::default();
        let e = world.spawn((
            FooBuilder {
                foo: Foo(9),
                bar: Some(Bar),
            },
            Foo(11),
        ));
        assert_eq!(world.get::<Foo>(e).unwrap().0, 11);
        assert!(world.has::<Bar>(e));
    }

    #[test]
    fn spawn_unfolds_components() {
        let mut world = World::default();
        let e = world.spawn(FooBuilder {
            foo: Foo(42),
            bar: Some(Bar),
        });
        assert_eq!(world.get::<Foo>(e).unwrap().0, 42);
        assert!(world.has::<Bar>(e));
    }

    #[test]
    fn optional_satellite_absent() {
        let mut world = World::default();
        let e = world.spawn(FooBuilder {
            foo: Foo(1),
            bar: None,
        });
        assert!(world.has::<Foo>(e));
        assert!(!world.has::<Bar>(e));
    }
}