bevy_reflect 0.19.0-rc.2

Dynamically interact with rust types
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
//! Module containing the [`ReflectDefault`] type.

use alloc::boxed::Box;
use core::ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Rem, RemAssign, Sub, SubAssign};

use crate::{FromType, PartialReflect, Reflect};

/// A struct used to provide the default value of a type.
///
/// A [`ReflectDefault`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectDefault {
    default: fn() -> Box<dyn Reflect>,
}

impl ReflectDefault {
    /// Returns the default value for a type.
    pub fn default(&self) -> Box<dyn Reflect> {
        (self.default)()
    }
}

impl<T: Reflect + Default> FromType<T> for ReflectDefault {
    fn from_type() -> Self {
        ReflectDefault {
            default: || Box::<T>::default(),
        }
    }
}

/// A struct used to perform addition on reflected values.
///
/// A [`ReflectAdd`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectAdd {
    /// Function pointer implementing [`ReflectAdd::add()`].
    pub add: fn(
        Box<dyn PartialReflect>,
        Box<dyn PartialReflect>,
    )
        -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)>,
}

impl ReflectAdd {
    /// Adds two reflected values together, returning the result as a new reflected value.
    ///
    /// # Errors
    ///
    /// Returns `Err((a, b))` if the types are incompatible.
    pub fn add(
        &self,
        a: Box<dyn PartialReflect>,
        b: Box<dyn PartialReflect>,
    ) -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)> {
        (self.add)(a, b)
    }
}

impl<T: Reflect + Add<Output: Reflect>> FromType<T> for ReflectAdd {
    fn from_type() -> Self {
        ReflectAdd {
            add: |a: Box<dyn PartialReflect>, b: Box<dyn PartialReflect>| {
                let (a, b) = match (a.try_downcast::<T>(), b.try_downcast::<T>()) {
                    (Ok(a), Ok(b)) => (a, b),
                    (a, b) => {
                        let a = a
                            .map(|a| a as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        let b = b
                            .map(|b| b as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        return Err((a, b));
                    }
                };
                Ok(Box::new(*a + *b))
            },
        }
    }
}

/// A struct used to perform subtraction on reflected values.
///
/// A [`ReflectSub`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectSub {
    /// Function pointer implementing [`ReflectSub::sub()`].
    pub sub: fn(
        Box<dyn PartialReflect>,
        Box<dyn PartialReflect>,
    )
        -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)>,
}

impl ReflectSub {
    /// Subtracts two reflected values, returning the result as a new reflected value.
    ///
    /// # Errors
    ///
    /// Returns `Err((a, b))` if the types are incompatible.
    pub fn sub(
        &self,
        a: Box<dyn PartialReflect>,
        b: Box<dyn PartialReflect>,
    ) -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)> {
        (self.sub)(a, b)
    }
}

impl<T: Reflect + Sub<Output: Reflect>> FromType<T> for ReflectSub {
    fn from_type() -> Self {
        ReflectSub {
            sub: |a: Box<dyn PartialReflect>, b: Box<dyn PartialReflect>| {
                let (a, b) = match (a.try_downcast::<T>(), b.try_downcast::<T>()) {
                    (Ok(a), Ok(b)) => (a, b),
                    (a, b) => {
                        let a = a
                            .map(|a| a as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        let b = b
                            .map(|b| b as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        return Err((a, b));
                    }
                };
                Ok(Box::new(*a - *b))
            },
        }
    }
}

/// A struct used to perform multiplication on reflected values.
///
/// A [`ReflectMul`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectMul {
    /// Function pointer implementing [`ReflectMul::mul()`].
    pub mul: fn(
        Box<dyn PartialReflect>,
        Box<dyn PartialReflect>,
    )
        -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)>,
}

impl ReflectMul {
    /// Multiplies two reflected values, returning the result as a new reflected value.
    ///
    /// # Errors
    ///
    /// Returns `Err((a, b))` if the types are incompatible.
    pub fn mul(
        &self,
        a: Box<dyn PartialReflect>,
        b: Box<dyn PartialReflect>,
    ) -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)> {
        (self.mul)(a, b)
    }
}

impl<T: Reflect + Mul<Output: Reflect>> FromType<T> for ReflectMul {
    fn from_type() -> Self {
        ReflectMul {
            mul: |a: Box<dyn PartialReflect>, b: Box<dyn PartialReflect>| {
                let (a, b) = match (a.try_downcast::<T>(), b.try_downcast::<T>()) {
                    (Ok(a), Ok(b)) => (a, b),
                    (a, b) => {
                        let a = a
                            .map(|a| a as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        let b = b
                            .map(|b| b as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        return Err((a, b));
                    }
                };
                Ok(Box::new(*a * *b))
            },
        }
    }
}

/// A struct used to perform division on reflected values.
///
/// A [`ReflectDiv`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectDiv {
    /// Function pointer implementing [`ReflectDiv::div()`].
    pub div: fn(
        Box<dyn PartialReflect>,
        Box<dyn PartialReflect>,
    )
        -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)>,
}

impl ReflectDiv {
    /// Divides two reflected values, returning the result as a new reflected value.
    ///
    /// # Errors
    ///
    /// Returns `Err((a, b))` if the types are incompatible.
    pub fn div(
        &self,
        a: Box<dyn PartialReflect>,
        b: Box<dyn PartialReflect>,
    ) -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)> {
        (self.div)(a, b)
    }
}

impl<T: Reflect + Div<Output: Reflect>> FromType<T> for ReflectDiv {
    fn from_type() -> Self {
        ReflectDiv {
            div: |a: Box<dyn PartialReflect>, b: Box<dyn PartialReflect>| {
                let (a, b) = match (a.try_downcast::<T>(), b.try_downcast::<T>()) {
                    (Ok(a), Ok(b)) => (a, b),
                    (a, b) => {
                        let a = a
                            .map(|a| a as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        let b = b
                            .map(|b| b as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        return Err((a, b));
                    }
                };
                Ok(Box::new(*a / *b))
            },
        }
    }
}

/// A struct used to perform remainder on reflected values.
///
/// A [`ReflectRem`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectRem {
    /// Function pointer implementing [`ReflectRem::rem()`].
    pub rem: fn(
        Box<dyn PartialReflect>,
        Box<dyn PartialReflect>,
    )
        -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)>,
}

impl ReflectRem {
    /// Computes the remainder of two reflected values, returning the result as
    /// a new reflected value.
    ///
    /// # Errors
    ///
    /// Returns `Err((a, b))` if the types are incompatible.
    pub fn rem(
        &self,
        a: Box<dyn PartialReflect>,
        b: Box<dyn PartialReflect>,
    ) -> Result<Box<dyn Reflect>, (Box<dyn PartialReflect>, Box<dyn PartialReflect>)> {
        (self.rem)(a, b)
    }
}

impl<T: Reflect + Rem<Output: Reflect>> FromType<T> for ReflectRem {
    fn from_type() -> Self {
        ReflectRem {
            rem: |a: Box<dyn PartialReflect>, b: Box<dyn PartialReflect>| {
                let (a, b) = match (a.try_downcast::<T>(), b.try_downcast::<T>()) {
                    (Ok(a), Ok(b)) => (a, b),
                    (a, b) => {
                        let a = a
                            .map(|a| a as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        let b = b
                            .map(|b| b as Box<dyn PartialReflect>)
                            .unwrap_or_else(|e| e);
                        return Err((a, b));
                    }
                };
                Ok(Box::new(*a % *b))
            },
        }
    }
}

/// A struct used to perform addition assignment on reflected values.
///
/// A [`ReflectAddAssign`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectAddAssign {
    /// Function pointer implementing [`ReflectAddAssign::add_assign()`].
    pub add_assign: fn(
        &mut dyn Reflect,
        Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>>,
}

impl ReflectAddAssign {
    /// Adds a reflected value to another reflected value in place.
    ///
    /// # Errors
    ///
    /// - Returns `Err(None)` if the first argument is of an incompatible type.
    /// - Returns `Err(Some(b))` if the second argument is of an incompatible type.
    pub fn add_assign(
        &self,
        a: &mut dyn Reflect,
        b: Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>> {
        (self.add_assign)(a, b)
    }
}

impl<T: Reflect + AddAssign> FromType<T> for ReflectAddAssign {
    fn from_type() -> Self {
        ReflectAddAssign {
            add_assign: |a: &mut dyn Reflect, b: Box<dyn PartialReflect>| {
                let Some(a) = a.downcast_mut::<T>() else {
                    return Err(None);
                };
                let b = match b.try_downcast::<T>() {
                    Ok(b) => b,
                    Err(b) => return Err(Some(b)),
                };
                *a += *b;
                Ok(())
            },
        }
    }
}

/// A struct used to perform subtraction assignment on reflected values.
///
/// A [`ReflectSubAssign`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectSubAssign {
    /// Function pointer implementing [`ReflectSubAssign::sub_assign()`].
    pub sub_assign: fn(
        &mut dyn Reflect,
        Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>>,
}

impl ReflectSubAssign {
    /// Subtracts a reflected value from another reflected value in place.
    ///
    /// # Errors
    ///
    /// - Returns `Err(None)` if the first argument is of an incompatible type.
    /// - Returns `Err(Some(b))` if the second argument is of an incompatible type.
    pub fn sub_assign(
        &self,
        a: &mut dyn Reflect,
        b: Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>> {
        (self.sub_assign)(a, b)
    }
}

impl<T: Reflect + SubAssign> FromType<T> for ReflectSubAssign {
    fn from_type() -> Self {
        ReflectSubAssign {
            sub_assign: |a: &mut dyn Reflect, b: Box<dyn PartialReflect>| {
                let Some(a) = a.downcast_mut::<T>() else {
                    return Err(None);
                };
                let b = match b.try_downcast::<T>() {
                    Ok(b) => b,
                    Err(b) => return Err(Some(b)),
                };
                *a -= *b;
                Ok(())
            },
        }
    }
}

/// A struct used to perform multiplication assignment on reflected values.
///
/// A [`ReflectMulAssign`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectMulAssign {
    /// Function pointer implementing [`ReflectMulAssign::mul_assign()`].
    pub mul_assign: fn(
        &mut dyn Reflect,
        Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>>,
}

impl ReflectMulAssign {
    /// Multiplies a reflected value by another reflected value in place.
    ///
    /// # Errors
    ///
    /// - Returns `Err(None)` if the first argument is of an incompatible type.
    /// - Returns `Err(Some(b))` if the second argument is of an incompatible type.
    pub fn mul_assign(
        &self,
        a: &mut dyn Reflect,
        b: Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>> {
        (self.mul_assign)(a, b)
    }
}

impl<T: Reflect + MulAssign> FromType<T> for ReflectMulAssign {
    fn from_type() -> Self {
        ReflectMulAssign {
            mul_assign: |a: &mut dyn Reflect, b: Box<dyn PartialReflect>| {
                let Some(a) = a.downcast_mut::<T>() else {
                    return Err(None);
                };
                let b = match b.try_downcast::<T>() {
                    Ok(b) => b,
                    Err(b) => return Err(Some(b)),
                };
                *a *= *b;
                Ok(())
            },
        }
    }
}

/// A struct used to perform division assignment on reflected values.
///
/// A [`ReflectDivAssign`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectDivAssign {
    /// Function pointer implementing [`ReflectDivAssign::div_assign()`].
    pub div_assign: fn(
        &mut dyn Reflect,
        Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>>,
}

impl ReflectDivAssign {
    /// Divides a reflected value by another reflected value in place.
    ///
    /// # Errors
    ///
    /// - Returns `Err(None)` if the first argument is of an incompatible type.
    /// - Returns `Err(Some(b))` if the second argument is of an incompatible type.
    pub fn div_assign(
        &self,
        a: &mut dyn Reflect,
        b: Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>> {
        (self.div_assign)(a, b)
    }
}

impl<T: Reflect + DivAssign> FromType<T> for ReflectDivAssign {
    fn from_type() -> Self {
        ReflectDivAssign {
            div_assign: |a: &mut dyn Reflect, b: Box<dyn PartialReflect>| {
                let Some(a) = a.downcast_mut::<T>() else {
                    return Err(None);
                };
                let b = match b.try_downcast::<T>() {
                    Ok(b) => b,
                    Err(b) => return Err(Some(b)),
                };
                *a /= *b;
                Ok(())
            },
        }
    }
}

/// A struct used to perform remainder assignment on reflected values.
///
/// A [`ReflectRemAssign`] for type `T` can be obtained via [`FromType::from_type`].
#[derive(Clone)]
pub struct ReflectRemAssign {
    /// Function pointer implementing [`ReflectRemAssign::rem_assign()`].
    pub rem_assign: fn(
        &mut dyn Reflect,
        Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>>,
}

impl ReflectRemAssign {
    /// Computes the remainder of a reflected value by another reflected value in place.
    ///
    /// # Errors
    ///
    /// - Returns `Err(None)` if the first argument is of an incompatible type.
    /// - Returns `Err(Some(b))` if the second argument is of an incompatible type.
    pub fn rem_assign(
        &self,
        a: &mut dyn Reflect,
        b: Box<dyn PartialReflect>,
    ) -> Result<(), Option<Box<dyn PartialReflect>>> {
        (self.rem_assign)(a, b)
    }
}

impl<T: Reflect + RemAssign> FromType<T> for ReflectRemAssign {
    fn from_type() -> Self {
        ReflectRemAssign {
            rem_assign: |a: &mut dyn Reflect, b: Box<dyn PartialReflect>| {
                let Some(a) = a.downcast_mut::<T>() else {
                    return Err(None);
                };
                let b = match b.try_downcast::<T>() {
                    Ok(b) => b,
                    Err(b) => return Err(Some(b)),
                };
                *a %= *b;
                Ok(())
            },
        }
    }
}