shipyard 0.11.2

Entity Component System
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
127
128
129
130

use shipyard::*;

#[test]
fn check_derive() {
    #[derive(Component, Unique, Borrow, BorrowInfo)]
    struct A {
        _a: (),
        _b: (),
        _c: (),
        _d: (),
    }

    #[derive(Component, Unique, Borrow, BorrowInfo)]
    struct B(A);

    #[allow(unused, reason = "This only checks the proc-macro compiles")]
    #[derive(WorldBorrow)]
    struct C {
        _c: (),
    }

    #[allow(unused, reason = "This only checks the proc-macro compiles")]
    #[derive(WorldBorrow)]
    struct D(C);

    #[allow(unused, reason = "This only checks the proc-macro compiles")]
    #[derive(Component, Unique)]
    struct E;

    #[derive(IntoIter)]
    struct CustomView<'a> {
        comp_a: shipyard::View<'a, A>,
        v_comp_aa: shipyard::View<'a, A>,
        comp_b: shipyard::ViewMut<'a, B>,
        vm_comp_bb: shipyard::ViewMut<'a, B>,
    }

    #[derive(IntoIter)]
    struct CustomView2<'a>(shipyard::View<'a, A>, shipyard::ViewMut<'a, B>);
}

/// Verify that the "default" attribute compiles.
/// And that we can borrow a view containing a default field.
#[test]
fn default() {
    #[derive(Borrow)]
    struct CustomView {
        #[shipyard(default)]
        _vec: Vec<usize>,
    }

    let world = World::new();

    world.borrow::<CustomView>().unwrap();
}

#[allow(unused)]
#[derive(Hash, Debug, PartialEq, Clone, Label)]
struct MyLabel;

#[test]
fn into_iter_rename() {
    #[derive(Component)]
    struct A;
    #[derive(Component)]
    struct B;
    #[derive(Component)]
    struct C;

    #[derive(Borrow, IntoIter)]
    #[shipyard(item_name = "OtherName")]
    struct AView<'a> {
        #[shipyard(item_field_name = "some_name")]
        a: View<'a, A>,
        #[shipyard(item_field_name = "some_other_name")]
        vm_b: ViewMut<'a, B>,

        #[shipyard(item_field_skip)]
        _aa: View<'a, A>,
        #[shipyard(item_field_skip)]
        _vm_c: ViewMut<'a, C>,
    }

    let world = World::new();

    world.run(|mut custom: AView| {
        for a in custom.iter() {
            let OtherName {
                some_name: _,
                some_other_name: _,
            } = a;
        }
    });
}

/// Checks that field visibility applies to the generated iterator.
#[test]
fn into_iter_field_visibility() {
    mod inner {
        use super::*;

        #[derive(Component)]
        pub struct A;

        #[derive(Component)]
        pub struct B;

        #[derive(IntoIter, Borrow)]
        pub struct CustomView<'a> {
            pub(super) comp_a: shipyard::View<'a, A>,
            pub(crate) v_comp_aa: shipyard::View<'a, A>,
            pub comp_b: shipyard::ViewMut<'a, B>,
            vm_comp_bb: shipyard::ViewMut<'a, B>,
        }
    }

    let world = World::new();
    let Ok(view) = world.borrow::<inner::CustomView>() else {
        // This function always returns here since 2 ViewMut cannot be borrowed
        // This test is only a compile check, not runtime

        return;
    };

    view.comp_a;
    view.comp_b;
    view.v_comp_aa;
    // Should not be accessible
    // view.v_comp_bb;
}