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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

use crate::{
    entity,
    hlist::{
        define_null,
        Get,
    },
    query::view,
    system::schedule::claim::decision,
};

define_null!();

// All of the possible cases of pairings between view and previous claims are enumerated below.
pub struct NotPresent;
pub struct ImmutImmut;
pub struct ImmutOptionImmut;
pub struct ImmutMut;
pub struct ImmutOptionMut;
pub struct MutImmut;
pub struct MutOptionImmut;
pub struct MutMut;
pub struct MutOptionMut;

/// Verifies whether a set of views, when compared with a claim, should result in an
/// `Append` or a `Cut` for the task.
///
/// Note that the `R` is not a proper `Registry`, but rather it is an inverse of the claimed views
/// `C` with respect to a `Registry` `R`.
pub trait Verifier<'a, R, C, I, P> {
    type Decision;
}

impl<'a, R, C> Verifier<'a, R, C, Null, Null> for view::Null {
    type Decision = decision::Append;
}

// ------------
// "Pass" cases
// ------------

/// Not present in the claims.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (NotPresent, P)> for (&'a T, U)
where
    R: Get<T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Not present in the claims.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (NotPresent, P)> for (&'a mut T, U)
where
    R: Get<T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Not present in the claims.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (NotPresent, P)> for (Option<&'a T>, U)
where
    R: Get<T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Not present in the claims.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (NotPresent, P)>
    for (Option<&'a mut T>, U)
where
    R: Get<T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Multiple immutable references are acceptable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutImmut, P)> for (&'a T, U)
where
    C: Get<&'a T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Multiple immutable references are acceptable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutImmut, P)> for (Option<&'a T>, U)
where
    C: Get<&'a T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Multiple immutable references are acceptable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutOptionImmut, P)> for (&'a T, U)
where
    C: Get<Option<&'a T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Multiple immutable references are acceptable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutOptionImmut, P)>
    for (Option<&'a T>, U)
where
    C: Get<Option<&'a T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = <U as Verifier<'a, R, C, IS, P>>::Decision;
}

/// Skip entity identifiers.
impl<'a, R, C, I, U, P> Verifier<'a, R, C, I, P> for (entity::Identifier, U)
where
    U: Verifier<'a, R, C, I, P>,
{
    type Decision = <U as Verifier<'a, R, C, I, P>>::Decision;
}

// ------------
// "Fail" cases
// ------------

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutMut, P)> for (&'a T, U)
where
    C: Get<&'a mut T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutOptionMut, P)> for (&'a T, U)
where
    C: Get<Option<&'a mut T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutMut, P)> for (Option<&'a T>, U)
where
    C: Get<&'a mut T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (ImmutOptionMut, P)>
    for (Option<&'a T>, U)
where
    C: Get<Option<&'a mut T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutMut, P)> for (&'a mut T, U)
where
    C: Get<&'a mut T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutOptionMut, P)> for (&'a mut T, U)
where
    C: Get<Option<&'a mut T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutMut, P)> for (Option<&'a mut T>, U)
where
    C: Get<&'a mut T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as mutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutOptionMut, P)>
    for (Option<&'a mut T>, U)
where
    C: Get<Option<&'a mut T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as immutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutImmut, P)> for (&'a mut T, U)
where
    C: Get<&'a T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as immutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutOptionImmut, P)> for (&'a mut T, U)
where
    C: Get<Option<&'a T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as immutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutImmut, P)> for (Option<&'a mut T>, U)
where
    C: Get<&'a T, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}

/// Previously borrowed as immutable.
impl<'a, R, C, I, IS, T, U, P> Verifier<'a, R, C, (I, IS), (MutOptionImmut, P)>
    for (Option<&'a mut T>, U)
where
    C: Get<Option<&'a T>, I>,
    U: Verifier<'a, R, C, IS, P>,
{
    type Decision = decision::Cut;
}